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

Make the extension Antora aware #299

Open
ggrossetie opened this issue Aug 10, 2019 · 1 comment
Open

Make the extension Antora aware #299

ggrossetie opened this issue Aug 10, 2019 · 1 comment

Comments

@ggrossetie
Copy link
Member

The extension should automatically detect an Antora documentation component and resolve external resources (images, partials, examples...).

@rgleason
Copy link

Antora uses nav.adoc files for the main index or outline. These often reside one directory above the other adoc files. Example: using GitHub/development/modules/ROOT/pages/
Also see https://github.com/opencpn-manuals/development for more details

nav.adoc - file
attachments - folder
images - folder
pages - folder

about.adoc (under pages) - asciidocbrowser nav.adoc links fail due to missing "/pages/"
info.adoc (under pages) - asciidocbrowser nav.adoc links fail due to missing "/pages/"

However we do not want to mess up the Antora output to html!!!

The links in nav.doc are not referencing the "/page/"

Example: github/development/modules/ROOT/about.adoc fails in the ascii browser extension

however these links work when Antora has run to output html and you use the html output.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants