Pages
- Confluence Publisher
Each AsciiDoc file (unless being an included file) will result in a separate Confluence page and must contain a top-level document title which will be used as the Confluence page title:
= Document Title
According to the restrictions of Confluence, document titles must be unique within the entire Confluence space the documentation is published to. The AsciiDoc file name itself is not reflected in Confluence.
Use the support for prefixes and suffixes to ensure uniqueness when publishing to the same Confluence space from multiple sources, or when publishing to a Confluence space that already contains manually maintained pages.
Keywords / Labels
AsciiDoc keywords defined using the :keywords attribute as page metadata are automatically added as labels to the
corresponding Confluence page:
:keywords: label-one, label-two
Links between Pages
Links between pages in Confluence are supported using AsciiDoc inter-document cross references. Target pages are referenced via the path to the corresponding AsciiDoc file. Paths are resolved relative to the location of the referencing AsciiDoc file. All referenced AsciiDoc files must be placed below the documentation root folder.
<<01-pages.adoc#, Link to Pages>> <<../00-index/06-images.adoc#, Link to Images>>
Links to other pages may also point to anchors within those pages. Either defined inline anchors or implicit anchor generated from headlines.
<<01-pages.adoc#paragraph-a], Link to Pages with inline anchor>> <<../00-index/06-images.adoc#_inline_images, Link to Images with headline anchor>>
Link to Pages with inline anchor Link to Images with headline anchor
Links within Pages
Links to content blocks within the same page are supported using AsciiDoc inline anchors and internal cross references:
[[paragraph-a]]Paragraph with inline anchor Another paragraph with internal cross-reference to <<paragraph-a>>
Paragraph with inline anchor
Another paragraph with internal cross-reference to [paragraph-a]
Links to sections within the same page are supported either using anchors or custom section ids:
[[section-a]] === Section with Anchor Paragraph with internal cross-reference to <<section-a>>
Section with Anchor
Paragraph with internal cross-reference to Section with Anchor
[#section-b] === Section with Custom Id Paragraph with internal cross-reference to <<section-b>>
Section with Custom Id
Paragraph with internal cross-reference to Section with Custom Id