dita bootstrap.lunr

Pesquisa de Lunr de Bootstrap Dita

O DITA Bootstrap Lunr Search é um plug-in Dita Open Toolkit que estende a saída HTML de Bootstrap DITA com uma função de pesquisa LUNR.JS.

• Instalação
  • Instalando Dita-ot
  • Instalando o plug-in
  • Instalando o Node.js
• Uso
  • Adicionando pesquisa LUNR à saída HTML Bootstrap
  • Adicionando pesquisa LUNR a uma ação do GitHub
  • Referência de parâmetro
• Licença

Instalação

O plug-in Dita Bootstrap Lunr foi testado com Dita-Ot 4.x. Use a versão mais recente para obter melhores resultados.

Instalando Dita-ot

1. Faça o download do pacote de distribuição mais recente do site do projeto em dita-ot.org/download.

2. Extraia o conteúdo do pacote para o diretório onde deseja instalar o DITA-OT.

3. Opcional : adicione o caminho absoluto para o diretório bin à variável do sistema de caminho .

   Isso define a variável de ambiente necessária para executar o comando dita na linha de comando.

Consulte a documentação DITA-OT para obter instruções detalhadas de instalação.

Instalando o plug-in

• Execute os comandos de instalação do 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

Instalando o Node.js

O plug-in de pesquisa de bootstrap de bootstrap dita usa o tempo de execução do node.js javascript para gerar o índice de pesquisa do LUNR.JS. O Node.js deve, portanto, estar presente para que o índice seja gerado com sucesso.

Para baixar e instalar uma cópia, siga as instruções para o seu sistema operacional na página de download.

Uso

Adicionando pesquisa LUNR à saída HTML Bootstrap

Para executar, use a transformação html5-bootstrap e adicione o 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

Um arquivo de cabeçalho de amostra com uma caixa de pesquisa é fornecido com o plug -in: inclui/hdr.navbar.lunr.xml - A marcação principal pode ser vista abaixo.

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

Adicionando pesquisa LUNR a uma ação do GitHub

Você pode usar o Dita-Ot-Action padrão para ser executado com a pesquisa LUNR. Como a transformação exige que o Node.js funcione, é necessário instalá -lo como parte do processo install . Além disso, ao criar documentos em outros idiomas que não o inglês, verifique se o locale apropriado foi definido antes da execução da transformação para garantir que o índice de pesquisa seja gerado corretamente.

 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

Referência de parâmetro

• offline.mode - Permite que a pesquisa do LUNR funcione em conjunto com o modo offline DITA Bootstrap - isso requer que um plug -in adicional seja instalado.

Licença

Apache 2.0 © 2023 Jason Fox

O programa inclui os seguintes componentes de software adicionais que foram obtidos sob licença:

• lunr.js - https://github.com/olivernn/lunr.js - MIT Licença
• Luguages ​​Lunr - https://github.com/mihaivalentin/lunr-languages ​​- Licença pública de Mozilla