dita bootstrap.lunr

Dita Bootstrap Lunr -Suche

Dita Bootstrap Lunr-Suche ist ein Dita Open Toolkit-Plug-In, das die Dita Bootstrap HTML-Ausgabe mit einer Suchfunktion von Lunr.js erweitert.

• Installation
  • Installieren von Dita-Ot
  • Installieren des Plug-Ins
  • Installieren von node.js
• Verwendung
  • Hinzufügen von Lunr -Suche in die HTML -Bootstrap -Ausgabe hinzufügen
  • Hinzufügen von Lunr -Suche zu einer GitHub -Aktion
  • Parameterreferenz
• Lizenz

Installation

Das DITA-Bootstrap-Lunr-Search- Plug-In wurde mit DITA-OT 4.x getestet. Verwenden Sie die neueste Version für die besten Ergebnisse.

Installieren von Dita-Ot

1. Laden Sie das neueste Distributionspaket von der Projektwebsite unter dita-oot.org/download herunter.

2. Extrahieren Sie den Inhalt des Pakets in das Verzeichnis, in dem Sie DITA-OT installieren möchten.

3. Optional : Fügen Sie den absoluten Pfad für das bin -Verzeichnis der Pfadsystemvariablen hinzu.

   Dies definiert die erforderliche Umgebungsvariable, um den Befehl dita aus der Befehlszeile auszuführen.

In der Dita-OT-Dokumentation finden Sie detaillierte Installationsanweisungen.

Installieren des Plug-Ins

• Führen Sie die Plug-in-Installationsbefehle aus:

 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

Installieren von node.js

Das Dita Bootstrap Lunr Search Plug-In verwendet die JavaScript-Laufzeit von Node.js, um den Lunr.js-Suchindex zu generieren. Node.js muss daher vorhanden sein, damit der Index erfolgreich erzeugt wird.

Um eine Kopie herunterzuladen und zu installieren, befolgen Sie die Anweisungen für Ihr Betriebssystem auf der Download -Seite.

Verwendung

Hinzufügen von Lunr -Suche in die HTML -Bootstrap -Ausgabe hinzufügen

Verwenden Sie zum Ausführen die html5-bootstrap Transformation und fügen Sie den args.hdr Parameter hinzu.

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

Eine Beispiel -Header -Datei mit einem Suchfeld ist mit dem Plug -In ausgestattet: Include/hdr.navbar.lunr.xml - Das Kernmarkt ist unten zu sehen.

< 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 >

Hinzufügen von Lunr -Suche zu einer GitHub -Aktion

Sie können die Standard-Dita-Ot-Action verwenden, um mit der Lunr-Suche auszuführen. Da die Transformation node.js erfordert, um zu funktionieren, müssen sie als Teil des install installiert werden. Stellen Sie beim Erstellen von Dokumenten in anderen Sprachen als Englisch sicher, dass das entsprechende locale vor dem Ausführen der Transformation festgelegt wurde, um sicherzustellen, dass der Suchindex korrekt generiert wird.

 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

Parameterreferenz

• offline.mode - Ermöglicht die Lunr -Suche in Verbindung mit dem Offline -Modus von Dita Bootstrap - Dies erfordert, dass ein zusätzliches Plugin installiert wird.

Lizenz

Apache 2.0 © 2023 Jason Fox

Das Programm enthält die folgenden zusätzlichen Softwarekomponenten, die unter Lizenz erhalten wurden:

• lunr.js - https://github.com/olivernn/lunr.js - MIT -Lizenz
• Lunr -Languages ​​- https://github.com/mihaivalentin/lunr-languages ​​- Mozilla Public Lizenz