Skip to content

Commit

Permalink
update readme and publish.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
rasummer committed Aug 19, 2024
1 parent 67fd300 commit 36b264d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 11 deletions.
12 changes: 4 additions & 8 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,11 @@ jobs:
- name: Install Node.js
uses: actions/setup-node@v2
with:
node-version: '14'
- name: Install Antora
run: npm i --no-optional --silent @antora/[email protected] @antora/[email protected]
- name: Install Lunr
run: npm i antora-lunr
- name: Install Lunr Site Generator
run: npm i antora-site-generator-lunr
node-version: '19'
- name: Install Antora and Lunr
run: npm i antora @antora/lunr-extension
- name: Run Antora
run: DOCSEARCH_ENABLED=true DOCSEARCH_ENGINE=lunr $(npm bin)/antora --fetch --generator antora-site-generator-lunr playbook.yml
run: npx antora antora-playbook.yml
- name: Publish to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
Expand Down
5 changes: 2 additions & 3 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,10 @@ The source files for this guide use asciidoc syntax and the project is configure

To build this guide locally, follow these steps:

. Follow the steps to install Antora that are described here: https://docs.antora.org/antora/2.0/install/install-antora/.
. Follow the steps to install Antora that are described here: https://docs.antora.org/antora/latest/install-and-run-quickstart/.
. Run `npm install -g asciidoc-link-check`
. Optional, to build with search enabled: Add the antora-lunr integration: https://github.com/Mogztter/antora-lunr by following the readme steps outlined in the *Generate an index file* section *only*. You do not need to enable search in the UI.

The command for building without search:
The command for building:
````
antora playbook.yml
````
Expand Down

0 comments on commit 36b264d

Please sign in to comment.