dita bootstrap.lunr

DITA BOOTSTRAP LUNR検索

Dita Bootstrap Lunr検索は、 lunr.js検索機能を備えたDITAブートストラップHTML出力を拡張するDITAオープンツールキットプラグインです。

• インストール
  • dita-otのインストール
  • プラグインのインストール
  • node.jsのインストール
• 使用法
  • HTMLブートストラップ出力にLUNR検索を追加します
  • GitHubアクションにLUNR検索を追加します
  • パラメーターリファレンス
• ライセンス

インストール

Dita Bootstrap Lutstrap Lunr検索プラグインは、Dita-OT 4.xでテストされています。最良の結果を得るには、最新バージョンを使用してください。

dita-otのインストール

1. プロジェクトWebサイト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 LUTSTRAP LUNR検索プラグインは、node.js JavaScriptランタイムを使用して、lunr.js検索インデックスを生成します。したがって、node.jsは、インデックスを正常に生成するために存在する必要があります。

コピーをダウンロードしてインストールするには、ダウンロードページでオペレーティングシステムの指示に従ってください。

使用法

HTMLブートストラップ出力にLUNR検索を追加します

実行するには、 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

検索ボックスを備えたサンプルヘッダーファイルには、プラグインが付属しています。

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

GitHubアクションにLUNR検索を追加します

標準の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-モジラ公開ライセンス