dita bootstrap.lunr

DITA Bootstrap Search Lunr

DITA Bootstrap Lunr Search هو مكون إضافي لـ DITA Open Toolkit يمتد إخراج HTML Bootstrap DITA مع وظيفة بحث LUNR.JS.

• تثبيت
  • تثبيت DITA-OT
  • تثبيت المكون الإضافي
  • تثبيت node.js
• الاستخدام
  • إضافة بحث LUNR إلى HTML الإخراج bootstrap
  • إضافة بحث LUNR إلى عمل github
  • مرجع المعلمة
• رخصة

تثبيت

تم اختبار المكون الإضافي لبحث LUNR Bootstrap DITA باستخدام 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

يستخدم المكون الإضافي لبحث Lunr Lunr DITA 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 القياسية لتشغيلها مع بحث 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 - ترخيص معهد ماساتشوستس للتكنولوجيا
• Lunr -languages ​​- https://github.com/mihaivalentin/lunr-languages ​​- رخصة موزيلا العامة