Skip to content

Latest commit

 

History

History
21 lines (14 loc) · 1013 Bytes

adding-metadata.md

File metadata and controls

21 lines (14 loc) · 1013 Bytes
Raw

Annotating a document with meta data

The documentation markdown files are allowed to contain meta data. This is done by adding YAML at the top of the document.

To add meta data, the metadata is between two lines, each with three dashes. Every line contains a keyword followed by a ':' and then the value e.g.:

---
keywords: content razor v8 version8
versionTo: 8.0.0
versionFrom: 7.3.4
---

Currently there are three different meta data properties supported:

  1. keywords: with space separated properties, adding the possibility to supply other keywords which improve findability
  2. versionFrom: an optional property with semver notation to indicate from which version this page is valid (or the feature the page describes has been introduced).
  3. versionTo: an optional property with semver notation to indicate till which version this page is valid

Related information: