dita bootstrap.lunr

Dita Bootstrap Lunr Search

Dita Bootstrap Lunr Search adalah plug-in toolkit terbuka DITA yang memperluas output HTML Dita Bootstrap dengan fungsi pencarian Lunr.js.

• Instalasi
  • Menginstal Dita-Ot
  • Memasang plug-in
  • Menginstal Node.js
• Penggunaan
  • Menambahkan pencarian lunr ke output bootstrap html
  • Menambahkan pencarian lunr ke tindakan github
  • Referensi parameter
• Lisensi

Instalasi

Dita Bootstrap Lunr Search Plug-in telah diuji dengan Dita-OT 4.x. Gunakan versi terbaru untuk hasil terbaik.

Menginstal Dita-Ot

1. Unduh paket distribusi terbaru dari situs web proyek di dita-ot.org/download.

2. Ekstrak isi paket ke direktori tempat Anda ingin menginstal Dita-Ot.

3. Opsional : Tambahkan jalur absolut untuk direktori bin ke variabel sistem jalur .

   Ini mendefinisikan variabel lingkungan yang diperlukan untuk menjalankan perintah dita dari baris perintah.

Lihat dokumentasi DITA-OT untuk instruksi instalasi terperinci.

Memasang plug-in

• Jalankan perintah pemasangan 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

Menginstal Node.js

Dita Bootstrap Lunr Search Plug-in menggunakan runtime Node.js JavaScript untuk menghasilkan indeks pencarian Lunr.js. Node.js karena itu harus ada agar indeks berhasil dihasilkan.

Untuk mengunduh dan menginstal salinan, ikuti instruksi untuk sistem operasi Anda di halaman unduhan.

Penggunaan

Menambahkan pencarian lunr ke output bootstrap html

Untuk menjalankan, gunakan transformasi html5-bootstrap dan tambahkan parameter args.hdr .

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

File header sampel dengan kotak pencarian disediakan dengan plug -in: Termasuk/hdr.navbar.lunr.xml - Markup inti dapat dilihat di bawah ini.

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

Menambahkan pencarian lunr ke tindakan github

Anda dapat menggunakan Dita-Ot-Action standar untuk dijalankan dengan pencarian Lunr. Karena transformasi membutuhkan node.js untuk berfungsi, perlu menginstalnya sebagai bagian dari proses install . Juga, saat membuat dokumen dalam bahasa selain bahasa Inggris, harap pastikan bahwa locale yang sesuai telah ditetapkan sebelum menjalankan transformasi untuk memastikan bahwa indeks pencarian dihasilkan dengan benar.

 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

Referensi parameter

• offline.mode - Mengaktifkan pencarian Lunr untuk bekerja bersama dengan mode Offline Dita Bootstrap - ini membutuhkan plugin tambahan untuk diinstal.

Lisensi

Apache 2.0 © 2023 Jason Fox

Program ini mencakup komponen perangkat lunak tambahan berikut yang diperoleh di bawah lisensi:

• lunr.js - https://github.com/olivernn/lunr.js - lisensi mit
• Lunr -Languages ​​- https://github.com/mihaivalentin/lunr-languages ​​- lisensi publik mozilla