dita bootstrap.lunr

Búsqueda dita bootstrap lunr

Dita Bootstrap Lunr Search es un complemento Dita Open Toolkit que extiende la salida DITA Bootstrap HTML con una función de búsqueda LUNR.JS.

• Instalación
  • Instalación de dita-ot
  • Instalación del complemento
  • Instalación de node.js
• Uso
  • Agregar búsqueda de LUNR a la salida de bootstrap HTML
  • Agregar búsqueda de Lunr a una acción de Github
  • Referencia de parámetros
• Licencia

Instalación

El complemento Dita Bootstrap Lunr Search se ha probado con DITA-OT 4.x. Use la última versión para obtener los mejores resultados.

Instalación de dita-ot

1. Descargue el último paquete de distribución del sitio web del proyecto en dita-ot.org/download.

2. Extraiga el contenido del paquete al directorio donde desea instalar Dita-OT.

3. Opcional : agregue la ruta absoluta para el directorio bin a la variable del sistema de ruta .

   Esto define la variable de entorno necesaria para ejecutar el comando dita desde la línea de comando.

Consulte la documentación DITA-OT para obtener instrucciones de instalación detalladas.

Instalación del complemento

• Ejecute los comandos de instalación del complemento:

 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

Instalación de node.js

El complemento Dita Bootstrap LUNR Search -In utiliza el tiempo de ejecución Node.js JavaScript para generar el índice de búsqueda de LunR.JS. Por lo tanto, Node.js debe estar presente para que el índice se genere con éxito.

Para descargar e instalar una copia, siga las instrucciones para su sistema operativo en la página de descarga.

Uso

Agregar búsqueda de LUNR a la salida de bootstrap HTML

Para ejecutar, use la transformación html5-bootstrap y agregue el parámetro args.hdr .

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

Se proporciona un archivo de encabezado de muestra con un cuadro de búsqueda con el complemento: Incluye/hdr.navbar.lunr.xml: el margen de núcleo se puede ver a continuación.

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

Agregar búsqueda de Lunr a una acción de Github

Puede usar el dita-ot-acción estándar para ejecutar con LUNR Search. Dado que la transformación requiere que nodo.js funcione, es necesario instalarlo como parte del proceso install . Además, al crear documentos en idiomas distintos del inglés, asegúrese de que la locale apropiada se haya establecido antes de ejecutar la transformación para garantizar que el índice de búsqueda se genere correctamente.

 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

Referencia de parámetros

• offline.mode : permite que la búsqueda de LUNR funcione junto con el modo Dita Bootstrap Offline: esto requiere que se instale un complemento adicional.

Licencia

Apache 2.0 © 2023 Jason Fox

El programa incluye los siguientes componentes de software adicionales que se obtuvieron bajo licencia:

• lunr.js - https://github.com/olivernn/lunr.js - Licencia del MIT
• Lunr-languages ​​- https://github.com/mihaivalentin/lunr-languages ​​- Licencia pública de Mozilla