diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2023-11-01 12:56:50 -0600 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2023-11-01 12:56:50 -0600 |
| commit | 9f7f6fdf0256592b929a09ba6133312d63e1c779 (patch) | |
| tree | abd1784f7ae917b8e7d013fb2214d6639e98edbb /docs | |
| parent | c7277233c8488a887bc9a4c4689d88e7ed42cc80 (diff) | |
skip-front-matter is an attribute, not an option
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/modules/html-backend/pages/skip-front-matter.adoc | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/modules/html-backend/pages/skip-front-matter.adoc b/docs/modules/html-backend/pages/skip-front-matter.adoc index 35433c04..6fb37cd4 100644 --- a/docs/modules/html-backend/pages/skip-front-matter.adoc +++ b/docs/modules/html-backend/pages/skip-front-matter.adoc @@ -23,8 +23,8 @@ content The static site generator removes these lines before passing the document to the AsciiDoc processor to be converted. Outside of the tool, however, these extra lines can throw off the processor. -== skip-front-matter option +== skip-front-matter attribute -If the `skip-front-matter` option is set via the API or CLI (e.g., `-a skip-front-matter`), Asciidoctor will recognize the front matter and consume it before parsing the document. -Asciidoctor stores the content it removes in the `front-matter` attribute to make it available for integrations. +If the `skip-front-matter` attribute is set via the API or CLI (e.g., `-a skip-front-matter`), Asciidoctor will recognize the front matter and consume it before parsing the document. +Asciidoctor stores the content it extracts in the `front-matter` attribute to make it available for integrations. Asciidoctor also removes front matter when reading xref:asciidoc:directives:include.adoc[include files]. |