Obsolète : nouveau référentiel ici
hexo-générateur-searchdb
Plugin générateur de données de recherche pour Hexo.
Ce plugin est utilisé pour générer un fichier d'index de recherche, qui contient toutes les données nécessaires de vos articles que vous pouvez utiliser pour écrire un moteur de recherche local pour votre blog. Prend en charge la sortie aux formats XML et JSON.
Installer
$ npm install hexo-generator-searchdb
Possibilités
Vous pouvez configurer ce plugin dans votre racine _config.yml
. Tous les arguments sont facultatifs.
search :
path : search.xml
field : post
content : true
format : html
- chemin - chemin du fichier. Par défaut, c'est
search.xml
. Si l'extension du fichier est .json
, le format de sortie sera JSON. Sinon, le fichier au format XML sera exporté. - champ - la portée de recherche que vous souhaitez rechercher, vous pouvez choisir :
- post (par défaut) - couvrira uniquement tous les articles de votre blog.
- page - ne couvrira que toutes les pages de votre blog.
- all - couvrira tous les articles et pages de votre blog.
- contenu - s'il contient l'intégralité du contenu de chaque article. Si
false
, les résultats générés couvrent uniquement le titre et les autres méta-informations sans le corps principal. Par défaut, c'est true
. - format - la forme du contenu de la page, les options sont :
- html (par défaut) - chaîne html originale en cours de réduction.
- striptags - la chaîne html originale en cours de réduction et supprime toutes les balises.
- brut - texte démarque de chaque article ou page.
FAQ
Qu'est-ce que ce plugin est censé faire ?
Ce plugin est utilisé pour générer un fichier xml/json à partir de votre blog Hexo qui fournit des données pour la recherche.
Où est enregistré ce fichier ?
Après avoir exécuté hexo g
vous obtiendrez le résultat généré dans votre dossier public.
Comment utiliser ce plugin dans mon blog Hexo ?
Vous avez deux choix :
- vous ne voulez pas écrire vous-même un moteur de recherche. De nombreux thèmes utilisent ce plugin pour une recherche locale qui fonctionne immédiatement.
- vous êtes familier avec l'API fetch ou jQuery Ajax et souhaitez écrire votre propre moteur de recherche. Vous pouvez en implémenter un vous-même selon le thème NexT. Lisez le code source de ce thème. Généralement il y a 3 étapes :
- écrire une vue de recherche. C'est l'endroit où afficher un formulaire de recherche et les résultats de la recherche ;
- écrire un script de recherche. Ce script indique au navigateur comment récupérer les données de recherche et filtrer le contenu que nous recherchons ;
- dites à hexo de connecter les deux parties ci-dessus.