dita bootstrap.lunr

Dita Bootstrap Lunr Search

Dita Bootstrap Lunr Search est un plug-in Dita Open Toolkit qui étend la sortie HTML Dita Bootstrap avec une fonction de recherche Lunr.js.

• Installation
  • Installation de Dita
  • Installation du plug-in
  • Installation de Node.js
• Usage
  • Ajout de recherche LUNR à la sortie HTML Bootstrap
  • Ajout de la recherche LUNR à une action GitHub
  • Référence du paramètre
• Licence

Installation

Le plug-in de recherche Dita Bootstrap Lunr a été testé avec Dita-Oot 4.x. Utilisez la dernière version pour les meilleurs résultats.

Installation de Dita

1. Téléchargez le dernier package de distribution sur le site Web du projet à Dita-ot.org/download.

2. Extraire le contenu du package dans le répertoire où vous souhaitez installer DITA-OT.

3. Facultatif : ajoutez le chemin absolu pour le répertoire bin à la variable du système de chemin .

   Cela définit la variable d'environnement nécessaire pour exécuter la commande dita à partir de la ligne de commande.

Voir la documentation DITA-OT pour les instructions d'installation détaillées.

Installation du plug-in

• Exécutez les commandes d'installation du plug-in:

 dita install https://github.com/jason-fox/fox.jason.extend.css/archive/master.zip
dita install https://github.com/infotexture/dita-bootstrap/archive/master.zip
dita install https://github.com/infotexture/dita-bootstrap.lunr/archive/master.zip

Installation de Node.js

Le plug-in Dita Bootstrap Lunr Search utilise l'exécution JavaScript Node.js pour générer l'index de recherche Lunr.js. Node.js doit donc être présent pour que l'index soit généré avec succès.

Pour télécharger et installer une copie, suivez les instructions de votre système d'exploitation sur la page de téléchargement.

Usage

Ajout de recherche LUNR à la sortie HTML Bootstrap

Pour exécuter, utilisez la transformation html5-bootstrap et ajoutez le paramètre args.hdr .

 PATH_TO_DITA_OT/bin/dita -f html5-bootstrap -o out -i PATH_TO_DITAMAP 
  --args.hdr=path/to/your-header.xml

Un exemple de fichier d'en-tête avec une zone de recherche est fourni avec le plug-in: inclut / hdr.navbar.lunr.xml - Le balisage de base peut être vu ci-dessous.

< li class = " nav-item d-flex align-items-center " >
  < span class = " nav-link pe-2 " >
    < i class = " bi bi-search " />
  </ span >
  < form class = " search-box position-relative me-auto " >
    < input type = " search " class = " form-control " placeholder = " Search… " aria-label = " Search for… " dir = " auto " />
  </ form >
</ li >

Ajout de la recherche LUNR à une action GitHub

Vous pouvez utiliser la DITA-OT-action standard pour fonctionner avec LUNR Search. Étant donné que la transformation nécessite que Node.js fonctionne, il est nécessaire de l'installer dans le cadre du processus install . De plus, lors de la création de documents dans des langues autres que l'anglais, veuillez vous assurer que le locale approprié a été défini avant l'exécution de la transformation pour vous assurer que l'index de recherche est généré correctement.

 name : Create DITA with Lunr Search (DE)
permissions :
  contents : write

' on ' :
  workflow_dispatch : null

jobs :
  build-dita :
    name : Build DITA
    runs-on : ubuntu-latest
    steps :
      - name : Git checkout
        uses : actions/checkout@v3
      - name : Build HTML5 + Bootstrap
        uses : dita-ot/[email protected]
        with :
          install : |
            apt-get update -q
            export DEBIAN_FRONTEND=noninteractive
            apt-get install -qy --no-install-recommends nodejs
            nodejs -v
            locale-gen de_DE.UTF-8
            LANG="de_DE.UTF-8"
            LANGUAGE="de_DE:de"
            LC_ALL="de_DE.UTF-8"
          plugins : |
            fox.jason.extend.css
            dita-bootstrap
            dita-bootstrap.lunr
          project : .github/dita-ot/html.xml
      - name : ' Deploy Documentation to GitHub Pages '
        uses : JamesIves/[email protected]
        with :
          token : ${{ secrets.GITHUB_TOKEN }}
          branch : gh-pages
          folder : out

Référence du paramètre

• offline.mode - permet à Lunr Search de fonctionner en conjonction avec le mode Offline Dita Bootstrap - cela nécessite un plugin supplémentaire à installer.

Licence

Apache 2.0 © 2023 Jason Fox

Le programme comprend les composants logiciels supplémentaires suivants qui ont été obtenus sous licence:

• lunr.js - https://github.com/olivernn/lunr.js - Licence MIT
• Lunr-Languages ​​- https://github.com/mihaivalentin/lunr-languages ​​- Licence publique de Mozilla