The /content
directory is where all the site's (English) Markdown content lives!
See the markup reference guide for more information about supported Markdown features.
See the contributing docs for general information about working with the docs.
YAML Frontmatter is an authoring convention popularized by Jekyll that provides a way to add metadata to pages. It is a block of key-value content that lives at the top of every Markdown file.
The following frontmatter values have special meanings and requirements for this site.
There's also a schema that's used by the test suite to validate every page's frontmatter.
See lib/frontmatter.js
.
- Purpose: Indicates the versions to which a page applies. See Versioning for more info.
- Type:
Object
. Allowable keys map to product names and can be found in theversions
object inlib/frontmatter.js
. - This frontmatter value is currently required for all pages.
- The
*
is used to denote all releases for the version.
Example that applies to GitHub.com and recent versions of GitHub Enterprise Server:
title: About your personal dashboard
versions:
free-pro-team: '*'
enterprise-server: '>=2.20'
Example that applies to all supported versions of GitHub Enterprise Server: (but not GitHub.com):
title: Downloading your license
versions:
enterprise-server: '*'