dita bootstrap.lunr

dita bootstrap lunr 검색

DITA Bootstrap LUNR 검색은 LUNR.JS 검색 기능을 사용하여 DITA Bootstrap HTML 출력을 확장하는 DITA Open Toolkit 플러그인입니다.

• 설치
  • dita-ot 설치
  • 플러그인 설치
  • Node.js 설치
• 용법
  • HTML 부트 스트랩 출력에 LUNR 검색 추가
  • GitHub 액션에 LUNR 검색 추가
  • 매개 변수 참조
• 특허

설치

Dita Bootstrap Lunr 검색 플러그인은 Dita-ot 4.x로 테스트되었습니다. 최상의 결과를 위해 최신 버전을 사용하십시오.

dita-ot 설치

1. 프로젝트 웹 사이트 (dita-ot.org/download에서 최신 배포 패키지를 다운로드하십시오.

2. DITA-OT를 설치하려는 디렉토리로 패키지의 내용을 추출하십시오.

3. 선택 사항 : bin 디렉토리의 절대 경로를 PATH 시스템 변수에 추가하십시오.

   이는 명령 줄에서 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가 존재해야합니다.

사본을 다운로드하고 설치하려면 다운로드 페이지에서 운영 체제의 지침을 따르십시오.

용법

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

검색 상자가있는 샘플 헤더 파일에는 플러그인이 제공됩니다 : 포함/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 >

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 Dita Bootstrap 오프라인 모드와 함께 LUNR 검색이 작동 할 수 있습니다. 추가 플러그인을 설치해야합니다.

특허

Apache 2.0 © 2023 Jason Fox

이 프로그램에는 라이센스에 따라 얻은 다음 추가 소프트웨어 구성 요소가 포함되어 있습니다.

• lunr.js -https://github.com/olivernn/lunr.js- MIT 라이센스
• LUNR -LANGUAGES -https://github.com/mihaivalentin/lunr -languages- Mozilla Public License