Hugo Search : un moteur de recherche interne (JQuery)

Article publié, le et modifié le
4 minute(s) de lecture

Cet article contient 641 mots.
Source brute de l'article : MD

Description

Intégrer une fonction de recherche au sein du site généré par Hugo peut se faire de différentes manières.

On va implémenter une manière très simple avec JQuery+UI, et cela nous prendra vraiment très peu de temps.

Étant donné qu’on peut parcourir l’ensemble des pages du site grâce à la variable .Site.Pages, on va se servir du mécanisme de la méthode autocomplete() fournie par la bibliothèque JQueryUI, pour restituer les différents résultats selon le texte écrit.

Bien sûr, j’assume le fait que vous savez intégrer les appels de scripts JQuery et JQueryUI au sein de votre propre site.

Documentation

La documentation officielle :

Codes

Hugo

Pour récupèrer les pages en codant Hugo :

Code : hugo

{{ $currentNode := . }}
{{ $currentNode.Scratch.Set "pages" .Site.Pages }}
{{ $pages := ($currentNode.Scratch.Get "pages") }}

Nous créeons une variable $pages qui contient l’ensemble des pages du site, que nous allons inclure dans le code JQuery.

JQueryUI

Pour la partie JQuery, nous utilisons la gestion des événements de la méthode autocomplete(), à la différence près est que la variable var projects va être implémentée par le biais de la fonction Hugo range appliquée sur la variable $pages.

Le code JQuery :

Code : javascript

$(function() {
    var projects = [
        {{ range $pages }}
        {
            value: "{{ .Title }}",
            label: "{{ .Title }}",
            url:"{{ .Permalink }}"
            },
        {{ end }}
    ];
    $( "#search" ).autocomplete({
        minLength: 0,
        source: projects,
        focus: function( event, ui ) {
            $( "#search" ).val( ui.item.label );
            return false;
        },
        select: function( event, ui ) {
            $( "#search" ).val( ui.item.label );
            $( "#project-id" ).val( ui.item.value );
            return false;
        }
    })
    .data( "ui-autocomplete" )._renderItem = function( ul, item ) {
        return $( "<li>" )
        .append( "<a href=" + item.url + " + \" &quot;\" +  >" + item.label + "</a>" )
        .appendTo( ul );
    };
});

HTML

Quant à la partie HTML, elle est très simple ; il faut à minima les deux éléments input suivants :

Code : html

<input id="search" class="form-control" placeholder="{{ i18n "searchHolderTitle" }}">
<input id="project-id" type="hidden">
  • Le premier élément input est celui qui “capte” le texte recherché
  • le second va permettre de retourner les informations trouvées.
  • La déclaration Hugo {{ i18n "searchHolderTitle" }} est juste pour le contexte multilangue de ce site ; à remplacer par du texte selon votre goût…

Que vous faites suivre du code Hugo puis du code JQuery

TL;DR

L’ensemble du code :

Code : html

        <div class="container">
            <input id="search" class="form-control" placeholder="{{ i18n "searchHolderTitle" }}">
            <input id="project-id" type="hidden">
            <!-- Javascript -->
                {{ $currentNode := . }}
                {{ $currentNode.Scratch.Set "pages" .Site.Pages }}
                {{ $pages := ($currentNode.Scratch.Get "pages") }}
                <script>
                    $(function() {
                    var projects = [
                        {{ range $pages }}
                        {
                            value: "{{ .Title }}",
                            label: "{{ .Title }}",
                            url:"{{ .Permalink }}"
                        },
                        {{ end }}
                    ];
                    $( "#search" ).autocomplete({
                            minLength: 0,
                            source: projects,
                            focus: function( event, ui ) {
                                $( "#search" ).val( ui.item.label );
                                return false;
                            },
                            select: function( event, ui ) {
                                $( "#search" ).val( ui.item.label );
                                $( "#project-id" ).val( ui.item.value );
                                return false;
                            }
                    })
                    .data( "ui-autocomplete" )._renderItem = function( ul, item ) {
                        return $( "<li>" )
                        .append( "<a href=" + item.url + " + \" &quot;\" +  >" + item.label + "</a>" )
                        .appendTo( ul );
                    };
                    });
                </script>
        </div>

Et, voilà !
En quelques minutes, un “moteur de recherche” interne intégré à votre site Hugo.

Pour ce qui est de la démonstration, c’est ce qu’il y a sur la page d’accueil de ce site ;)


Documentations