trying antora

This commit is contained in:
jstaerk
2023-02-27 15:13:55 +01:00
parent 22591398d8
commit 6372d8c7d2
8 changed files with 483 additions and 0 deletions

View File

@@ -0,0 +1,33 @@
= Welcome to Component B!
:navtitle: Welcome
This is the automatic start page for version *{page-component-display-version}* of Component B.
Component B is one of two documentation components in the Antora Demo.
The other docs component, Component A, can be accessed using the component selector menu (aka component drawer) at the bottom of the menu on the left side of the page.
== Page source
This page is sourced from the AsciiDoc file named [.path]_index.adoc_ that is located at [.path]_demo-component-b/docs/modules/ROOT/pages_.
=== Why is this the home page of Component B?
This page is automatically used as the start page of Component B because it is stored in the ROOT module and named [.path]_index.adoc_.
=== Why is this the home page of the Antora Demo site?
This page is used as the home page for the Antora Demo because it is assigned as the site `start_page` in the Demo site's playbook file [.path]_site.yml_.
== Cross reference syntax to target this page
To create a cross reference *to this page from another page in the ROOT module of Component B*, the xref syntax would be `\xref:index.adoc[]`.
To create a cross reference *to this page from a page in Module One of Component B*, the xref syntax would be `\xref:ROOT:index.adoc[]`.
=== Always target the latest version of this page
To create a cross reference *to the latest version of this page from a page in Component A*, the xref syntax would be `\xref:component-b::index.adoc[]`.
=== Target a specific version of this page
To create a cross reference *to version 1.0 of this page from a page in Component A*, the xref syntax would be `\xref:1.0@component-b::index.adoc[]`.