hugo search fuse js

Recherche en direct d'Hugo à l'aide de Fuse.js et Mark.js

Ce n'est pas un thème autonome. Il s'agit d'un composant du thème Hugo.

Pour utiliser ce composant,

1. Ajoutez ceci au fichier de configuration TOML de votre site :

   [ module ]
     [[ module . imports ]]
       path = " github.com/kaushalmodi/hugo-search-fuse-js "

2. Exécutez hugo mod tidy dans le répertoire principal de votre site. Le dépôt du site principal doit également être un module Hugo (il doit avoir son propre go.mod ). Pour en faire un, exécutez hugo mod init <your site url or any unique string> dans le dépôt de votre site avant d'effectuer cette étape.

3. Créez content/search.md avec le paramètre layout défini sur "search" et le paramètre output défini sur ["html", "json"] . Le contenu ou le corps de ce search.md n'est pas utilisé par le modèle search.html qui fait partie de ce composant de thème.

   Voici un exemple search.md :

    +++
   title = " Search "
   layout = " search "
   outputs = [ " html " , " json " ]
   [ sitemap ]
     priority = 0.1
   +++

Exigences

Vous devez installer la dernière version de Go à partir de https://go.dev/doc/install car ce composant de thème nécessite les commandes hugo mod .. pour fonctionner.

Cette mise à jour sur le passage à l'utilisation des modules Hugo a été testée pour la dernière fois avec Hugo v0.92.0.

1. Votre thème principal doit être structuré à l'aide d'un modèle et de blocs de base, et
2. Le modèle base doit définir les blocs main et footer (affichés dans ce lien précédent).

Si le thème principal ne répond pas à ces exigences, vous devrez modifier le partiel search.html pour que la recherche fonctionne. Vous pouvez le trouver dans layouts/_default/search.html dans ce composant.

Que faire si le thème principal n'a pas baseof.html ?

Vous avez deux options :

1. Modifiez le search.html pour l'adapter à votre thème.
2. Mettez à niveau le thème pour utiliser la nouvelle approche « modèle de base et blocs ».

Que se passe-t-il si le thème principal a baseof.html , mais n'a pas les blocs main et/ou footer ?

Il est très facile d'ajouter ces blocs sans casser votre thème existant.

Pour ajouter le bloc main , ajoutez ceci à votre baseof.html à l'endroit approprié :

 {{ block "main" . }}{{ end }}

Et de la même manière, ajoutez ce qui suit si le bloc footer est manquant :

 {{ block "footer" . }}{{ end }}

Pour un exemple, consultez l'extrait baseof.html dans la documentation Hugo.

Crédits

• Fonctionnalité de recherche par fuse.js.
• Mise en évidence des mots clés par mark.js.
• Implémentation initiale de Hugo par @eddiewebb dans cet aperçu.
• Emballage des composants du thème Hugo par @kaushalmodi.
• Suppression de jQuery et intégration de IE polyfill par @lpar.
• Polyfills de compatibilité IE :
  • Promesses
  • Aller chercher
  • URLSearchParams
  • API de modèles et de fragments
  • Noeud.remove