YAML Front Matter and Attribute Reference

YAML front matter

YAML front matter must always be at the top of the document.

book_path

Required Yes
Applies to All markdown pages
Description Specifies the location of the _book.yaml used to generate the table of contents.
Example book_path: /web/section/_book.yaml

description

RequiredNo
Applies to All markdown pages
Description You can provide a page description in the YAML front matter that is used as the `meta` description for the page. The description should be short (<450 char), and only provide a brief synopsis of the page.
Example description: Lorem ipsum
Notes Do not include any HTML or Markdown in the description field.

full_width

RequiredNo
Applies to All markdown pages
Description Relinquishes control over the layout for the area below the site header and project bar and above the site footer.
Example full_width: true
Notes Not supported in the development environment.

hide_last_updated

RequiredNo
Applies to All markdown pages
Description Hides the automatically generated last updated field at the bottom of the page.
Example hide_last_updated: true
Notes Not supported in the development environment.

project_path

Required Yes
Applies to All markdown pages
Description Specifies the location of the _project.yaml used to tell DevSite about the current project.
Example project_path: /web/_project.yaml
Notes If the path book cannot be found, the page will not include the left nav and the upper tabs will not be properly highlighted.

Special attributes

wf_auto_generated

RequiredNo
Applies to Auto-generated markdown pages
Description Automatically added to files that are generated through some build system. Changes the types of tests that are run against the file.
Example {# wf_auto_generated #}

wf_devsite_translation

Required No
Applies to Markdown pages translated by DevSite
Description Automatically added to files that are translated by the DevSite translation team. Changes the types of tests that are run against the file.
Example {# wf_devsite_translation #}

wf_md_include

Required Yes
Applies to Only markdown files that are included in other markdown files
Description Indicates that a file is only meant to be included in another markdown file, changes the types of tests run against the file.
Example {# wf_md_include #}

wf_podcast_audio

Required Yes
Applies to Only podcast episode markdown files
Description Link to the actual MP3 download.
Example {# wf_podcast_audio: https://example.com/path/episode.mp3 #}

wf_podcast_duration

Required Yes
Applies to Only podcast episode markdown files
Description Duration of the podcast (HH:MM:SS)
Example {# wf_podcast_duration: 00:30:37 #}

wf_podcast_fileSize

Required Yes
Applies to Only podcast episode markdown files
Description File size (in bytes) of the MP3 download
Example {# wf_podcast_fileSize: 29803546 #}

wf_podcast_subtitle

Required Yes
Applies to Only podcast episode markdown files
Description Podcast subtitle
Example {# wf_podcast_subtitle: Paul and Jake talk about CORS. #}

wf_published_on

Required Yes
Applies to All markdown pages
Description Identifies the original date the article was written and meant for publication. It is used by the build system for sorting articles, and is only ever shown to users in the RSS/ATOM feeds.
Example {# wf_published_on: 2017-12-06 #}
Notes Format for the date is YYYY-MM-DD.

wf_region

Required Yes
Applies to Only markdown pages in showcase
Description A comma separated list of regions that the showcase should be listed in.
Example {# wf_region: asia,europe #}
Valid regions
  • africa
  • asia
  • europe
  • middle-east
  • north-america
  • south-america

wf_tags

Required Yes
Applies to Only markdown pages in updates and showcase
Description A comma separated list of tags related to the article.
Example {# wf_tags: devtools,geolocation,gulp,getusermedia #}
Notes If the tag doesn't exist in the current list, add it to commonTags.json

wf_updated_on

Required Yes
Applies to All markdown pages
Description Identifies the when the article was last updated. It is used by the build system for sorting articles, and is only ever shown to users in the RSS/ATOM feeds. It is also used for helping identify which localized articles need to be updated.
Example {# wf_updated_on: 2017-12-06 #}
Notes Format for the date is YYYY-MM-DD.

wf_vertical

Required Yes
Applies to Only markdown pages in showcase
Description Used to identify which vertical a showcase should be listed in.
Example {# wf_vertical: education,media #}
Valid verticals
  • education
  • entertainment
  • media
  • real-estate
  • retail
  • transportation
  • travel

Other

Page title

Required Yes
Applies to All markdown pages
Description The page title is defined by the first H1-like tag with the .page-title class.
Example # Writing an Article {: .page-title }
Notes Page titles should not include any markdown or HTML tags.

Author attribution

Required Strongly encouraged
Applies to All markdown pages
Description Defines the name of the author at the top of the page
Example {% include "web/_shared/contributors/petelepage.html" %}
Notes Author attribution should go at the top of the page.

Translator attribution

Required Strongly encouraged
Applies to All translated markdown pages
Description Provides credit to the person who translated the article.
Example

Translated by:
{% include "web/_shared/contributors/petelepage.html" %}
      
Notes Translator attribution should go at the end of the page.