dita bootstrap.lunr

การค้นหา Dita Bootstrap Lunr

การค้นหา DITA Bootstrap Lunr เป็นปลั๊กอิน DITA Open Toolkit ที่ขยายเอาต์พุต DITA Bootstrap HTML ด้วยฟังก์ชั่นการค้นหา LUNR.JS

• การติดตั้ง
  • การติดตั้ง DITA-OT
  • การติดตั้งปลั๊กอิน
  • การติดตั้ง node.js
• การใช้งาน
  • การเพิ่มการค้นหา LUNR ไปยัง HTML bootstrap output
  • การเพิ่มการค้นหา LUNR ในการกระทำของ GitHub
  • การอ้างอิงพารามิเตอร์
• ใบอนุญาต

การติดตั้ง

ปลั๊กอิน การค้นหา DITA Bootstrap Lunr ได้รับการทดสอบด้วย DITA-OT 4.X ใช้เวอร์ชันล่าสุดเพื่อผลลัพธ์ที่ดีที่สุด

การติดตั้ง DITA-OT

1. ดาวน์โหลดแพ็คเกจการกระจายล่าสุดจากเว็บไซต์โครงการที่ 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 ใช้รันไทม์ JavaScript Node.js เพื่อสร้างดัชนีการค้นหา LUNR.JS node.js จะต้องนำเสนอสำหรับดัชนีที่จะสร้างได้สำเร็จ

ในการดาวน์โหลดและติดตั้งสำเนาให้ทำตามคำแนะนำสำหรับระบบปฏิบัติการของคุณในหน้าดาวน์โหลด

การใช้งาน

การเพิ่มการค้นหา LUNR ไปยัง HTML bootstrap output

ในการเรียกใช้ให้ใช้การแปลง 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 - ต้องใช้ปลั๊กอินเพิ่มเติมที่จะติดตั้ง

ใบอนุญาต

Apache 2.0 © 2023 Jason Fox

โปรแกรมรวมส่วนประกอบซอฟต์แวร์เพิ่มเติมต่อไปนี้ซึ่งได้รับภายใต้ใบอนุญาต:

• lunr.js - https://github.com/olivernn/lunr.js - ใบอนุญาต MIT
• Lunr -Languages ​​- https://github.com/mihaivalentin/lunr-languages ​​- ใบอนุญาตสาธารณะ Mozilla