Skip to main content

Front-Matter Properties

This page describes what front-matter properties in Markdown are and how we use them in documentation.

When to add front-matter properties​

When creating documentation in Markdown for ScalarDB, you must include front-matter properties that include the tag attribute. By including tags for editions in the front-matter properties, the page on the ScalarDB documentation site will show which versions of ScalarDB the document is applicable to.

To add the tag attribute, copy the following front-matter properties and paste the properties at the top of your Markdown file:

---
tag:
  - <EDITION_TYPE>
  - <EDITION_TYPE>
  - <EDITION_TYPE>
---

Then, replace <EDITION_TYPE> with the editions that apply to the document. The following are edition tags that you can add:

  • Community
  • Enterprise Standard
  • Enterprise Premium
  • Enterprise Option
  • Private Preview

Example​

---
tag:
  - Community
  - Enterprise Standard
  - Enterprise Premium
---