Add docs

asciidoctor · Feb 8, 2024 · 589b744 · 589b744
1 parent c9d1a06
commit 589b744
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git 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
@@ -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 `<meta name="author" ... >` tags inside the HTML `<head>`.
+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 `<meta name="date" ... >` element.
+Alternatively, if not set, the generated value of `docdatetime` will be used.