Skip to content

Update Contributor's Guide for Required Attributes #839

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 27, 2025
Merged

Update Contributor's Guide for Required Attributes #839

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion home/modules/contribute/pages/attributes-and-roles.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,14 @@ In this case, the tabs feature is turned on by setting `tabs`.
<5> Reference an attribute in the body of the document by entering the attribute name inside a set of curly brackets (`+{attribute-name}+`).
<6> Code blocks are assigned the source language `javascript`.

== Available Document Attributes
== Required Document Attributes

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

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

== Optional Document Attributes

You can also use the following optional attributes:

include::partial$available-attributes.adoc[tag=optional]
Expand Down
8 changes: 4 additions & 4 deletions home/modules/contribute/partials/available-attributes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ a| * For concepts: `concept`
* For tasks: `guide`
* For references: `reference`

| `:keywords:`
| Use the `keywords` attribute to add meta keywords to the HTML head for your page.
| Any applicable keyword, separated by commas (`,`).

| `:description:`
| 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.
a| Enter a quick description of the content on the page.
Expand Down Expand Up @@ -38,10 +42,6 @@ a| `:imagesdir: ../assets/images`

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

| `:keywords:`
| Use the `keywords` attribute to add meta keywords to the HTML head for your page.
| Any applicable keyword, separated by commas (`,`).

| `:page-aliases:`
a| Use the `page-aliases` attribute when you need to delete or rename a page to avoid breaking links.
Antora will resolve any links to the filename(s) you specify in this attribute to redirect to the current page, instead.
Expand Down