Skip to content

Commit

Permalink
resolves #172 document that page attributes must be defined in the do…
Browse files Browse the repository at this point in the history
…cument header
  • Loading branch information
mojavelinux committed Oct 28, 2018
1 parent c14141e commit 49ca144
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -203,10 +203,20 @@ For example, here's how you can assign a value to the `page.header.image` page v
:page-header: { image: logo.png }
----

IMPORTANT: The AsciiDoc document header stops after the first blank line.
You may use include directives in the the document header, but make sure the included file does not contain a blank line.
To define a page attribute that contains multiple words, use either a hyphen or underscore character to connect the words.

TIP: Use either a hyphen or an underscore as a separator for page attributes with multiple words (e.g., page-short-name).
[source,asciidoc]
----
:page-short-name: slug
----

IMPORTANT: Page attributes must be defined in the document header.
That means either putting them directly below the document title (the line beginning with a single equals sign in the sample above) or above all other AsciiDoc content if the document title is not defined in AsciiDoc.
The AsciiDoc document header stops after the first blank line.
For more details about the document header, see the http://asciidoctor.org/docs/user-manual/#doc-header[Document Header] chapter in the Asciidoctor User Manual.

IMPORTANT: You may use include directives in the the document header.
However, you must ensure that the file included _does not_ contain blank lines.

=== Specifying a Layout

Expand Down

0 comments on commit 49ca144

Please sign in to comment.