From 36b264d4d9923eb5835cc9f81ff4addf9d9eb34b Mon Sep 17 00:00:00 2001 From: Richard Summerhayes Date: Mon, 19 Aug 2024 12:02:55 -0700 Subject: [PATCH] update readme and publish.yml --- .github/workflows/publish.yml | 12 ++++-------- README.adoc | 5 ++--- 2 files changed, 6 insertions(+), 11 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 94ddab0..9189cef 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -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/cli@2.3.4 @antora/site-generator-default@2.3.4 - - 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: diff --git a/README.adoc b/README.adoc index 5564b77..7d69166 100644 --- a/README.adoc +++ b/README.adoc @@ -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 ````