From 589b7446347983230809aa119ef80de961e183fe Mon Sep 17 00:00:00 2001 From: Abel Salgado Romero Date: Thu, 8 Feb 2024 22:59:49 +0100 Subject: [PATCH] Add docs --- docs/modules/site-integration/nav.adoc | 1 + .../site-integration/pages/exposed-metadata.adoc | 16 ++++++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 docs/modules/site-integration/pages/exposed-metadata.adoc diff --git a/docs/modules/site-integration/nav.adoc b/docs/modules/site-integration/nav.adoc index 15c48838..71ff6b19 100644 --- a/docs/modules/site-integration/nav.adoc +++ b/docs/modules/site-integration/nav.adoc @@ -1,4 +1,5 @@ * Maven Site Integration ** xref:introduction.adoc[] ** xref:setup-and-configuration.adoc[] +** xref:exposed-metadata.adoc[] ** xref:compatibility-matrix.adoc[] diff --git a/docs/modules/site-integration/pages/exposed-metadata.adoc b/docs/modules/site-integration/pages/exposed-metadata.adoc new file mode 100644 index 00000000..000d1f70 --- /dev/null +++ b/docs/modules/site-integration/pages/exposed-metadata.adoc @@ -0,0 +1,16 @@ += Exposed metadata +:asciidoctor-docs-url: https://docs.asciidoctor.org/asciidoc/latest + +The Asciidoctor Maven Site integration integrates with Doxia to expose some of its information. + +== Document Header metadata + +The following information from the {asciidoctor-docs-url}/document/header/[header] is extracted: + +document title:: used to inform the breadcrumb line when these are enabled. + +author(s):: full representation (full name and email) will be present as HTML `` tags inside the HTML ``. +In case of multiple authors, each one will appear in a distinct meta element. + +revision date:: the header revision date value wll be presented as-is in a `` element. +Alternatively, if not set, the generated value of `docdatetime` will be used.