Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Antora 3 upgrade #3

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
updated readme
  • Loading branch information
rasummer committed Aug 19, 2024
commit 67fd300a045a2abb74d89c1ab5983a399a5f4f53
8 changes: 1 addition & 7 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,6 @@ The command for building without search:
antora playbook.yml
````

The command for building with search enabled:

````
DOCSEARCH_ENABLED=true DOCSEARCH_ENGINE=lunr NODE_PATH="$(npm -g root)" antora --generator antora-site-generator-lunr playbook.yml
````

To preview

````
Expand All @@ -37,6 +31,6 @@ $ python -m SimpleHTTPServer

Antora is built on top of Asciidoctor. One of the main differences between Asciidoctor and Antora is that Antora requires a specfic directory structure. If you are new to Antora and asciidoc, the following references might be helpful:

* https://docs.antora.org/antora/2.0/
* https://docs.antora.org/antora/latest/
* https://asciidoctor.org/docs/
* http://asciidoc.org/