Skip to content

Commit 9b8bb2a

Browse files
authored
Enforce required attributes and establish :keywords: as required (#839)
1 parent ae3b67b commit 9b8bb2a

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

home/modules/contribute/pages/attributes-and-roles.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,14 @@ In this case, the tabs feature is turned on by setting `tabs`.
4545
<5> Reference an attribute in the body of the document by entering the attribute name inside a set of curly brackets (`+{attribute-name}+`).
4646
<6> Code blocks are assigned the source language `javascript`.
4747

48-
== Available Document Attributes
48+
== Required Document Attributes
4949

5050
The following document attributes must be included for every AsciiDoc file stored in a *pages* directory:
5151

5252
include::partial$available-attributes.adoc[tag=required]
5353

54+
== Optional Document Attributes
55+
5456
You can also use the following optional attributes:
5557

5658
include::partial$available-attributes.adoc[tag=optional]

home/modules/contribute/partials/available-attributes.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ a| * For concepts: `concept`
1010
* For tasks: `guide`
1111
* For references: `reference`
1212

13+
| `:keywords:`
14+
| Use the `keywords` attribute to add meta keywords to the HTML head for your page.
15+
| Any applicable keyword, separated by commas (`,`).
16+
1317
| `:description:`
1418
| The page description is used for SEO and provides a brief description of the page, which is displayed using the `[abstract]` attribute on the page.
1519
a| Enter a quick description of the content on the page.
@@ -38,10 +42,6 @@ a| `:imagesdir: ../assets/images`
3842

3943
Try to keep your images inside the `assets/images` folder in a module.
4044

41-
| `:keywords:`
42-
| Use the `keywords` attribute to add meta keywords to the HTML head for your page.
43-
| Any applicable keyword, separated by commas (`,`).
44-
4545
| `:page-aliases:`
4646
a| Use the `page-aliases` attribute when you need to delete or rename a page to avoid breaking links.
4747
Antora will resolve any links to the filename(s) you specify in this attribute to redirect to the current page, instead.

0 commit comments

Comments
 (0)