dita bootstrap.lunr

Dita Bootstrap LUNR Search

DITA Bootstrap LUNR Search -это плагин DITA Open Toolkit, который расширяет вывод HTML DITA Bootstrap с функцией поиска LUNR.JS.

• Установка
  • Установка Dita-ot
  • Установка плагина
  • Установка node.js
• Использование
  • Добавление поиска LUNR к выводу HTML Bootstrap
  • Добавление поиска LUNR к действию GitHub
  • Ссылка на параметр
• Лицензия

Установка

Подключатель поиска Dita Bootstrap LUNR был протестирован с Dita-OT 4.x. Используйте последнюю версию для достижения наилучших результатов.

Установка Dita-ot

1. Загрузите последний пакет дистрибуции с веб-сайта Project по адресу dita-ot.org/download.

2. Извлеките содержимое пакета в каталог, где вы хотите установить Dita-Ot.

3. Необязательно : добавьте абсолютный путь для каталога bin в переменную системы пути .

   Это определяет необходимую переменную среды для запуска команды dita из командной строки.

Смотрите документацию Dita-OT для подробных инструкций по установке.

Установка плагина

• Запустите команды установки плагина:

 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

Установка node.js

Подключатель поиска DITA Bootstrap LUNR использует время выполнения node.js JavaScript для генерации индекса поиска LUNR.JS. Поэтому Node.js должен присутствовать для успешного сгенерированного индекса.

Чтобы загрузить и установить копию, следуйте инструкциям для вашей операционной системы на странице загрузки.

Использование

Добавление поиска LUNR к выводу HTML Bootstrap

Для запуска используйте преобразование html5-bootstrap и добавьте параметр args.hdr .

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

Образец заголовочного файла с окном поиска предоставлен с помощью плагина: включение/hdr.navbar.lunr.xml - показатель ядра можно увидеть ниже.

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

Добавление поиска LUNR к действию GitHub

Вы можете использовать стандартный Dita-ot-Action для запуска с поиском LUNR. Поскольку преобразование требует функционирования node.js, необходимо установить его как часть процесса install . Кроме того, при создании документов на языках, отличных от английского, убедитесь, что соответствующий locale был установлен до запуска преобразования, чтобы убедиться, что индекс поиска генерируется правильно.

 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

Ссылка на параметр

• offline.mode - позволяет поиску LUNR работать в сочетании с режимом DITA Bootstrap Offline - для этого требуется дополнительный плагин.

Лицензия

Apache 2.0 © 2023 Джейсон Фокс

Программа включает в себя следующие дополнительные программные компоненты, которые были получены по лицензии:

• lunr.js - https://github.com/olivernn/lunr.js - лицензия MIT
• LUNR -Languages ​​- https://github.com/mihaivalentin/lunr-languages ​​- Public License Mozilla