Skip to content

Front matter metadata structure

Front matter metadata consists of a block of YAML or Key-Value data placed at the beginning of a file, situated between the opening and closing delimiters (typically ---).^[600-developer__java__java-security__java-security.md] This structured area is used to define the document's attributes, independent of the main content body.^[600-developer__java__java-security__java-security.md]

Common Fields

While specific keys can vary based on the system or theme in use, the front matter typically includes standard variables such as the document title, author, tags, and date.^[600-developer__java__java-security__java-security.md] Additionally, boolean flags like toc (table of contents) may be used to control the rendering or layout features of the document.^[600-developer__java__java-security__java-security.md]

Placement and Syntax

The metadata block must appear at the very top of the file, preceding the content sections like # 簡介 (Introduction) or # 內容 (Content).^[600-developer__java__java-security__java-security.md] It is enclosed by --- markers, which distinctively separate the configuration metadata from the body text and reference lists.^[600-developer__java__java-security__java-security.md]

Sources

  • 600-developer__java__java-security__java-security.md