1
0
silverbullet/website/Frontmatter.md
Nguyen Long Nhat acec440444
Fix some grammars (#170)
Fix grammar
2022-12-07 17:05:27 +01:00

1.1 KiB
Raw Blame History

Frontmatter is a common format to attach additional metadata (data about data) to markdown documents.

You create it by starting your markdown document with --- followed by YAML encoded attributes and then ending with --- again. Followed by the regular body of your document.

Here is an example:

---
status: Draft
tags:
- tag1
- tag2
---
## This is a section
This is content

Silver Bullet allows arbitrary metadata to be added to pages this way, with two exceptions:

  • name is an attribute used for page names, so dont attempt to override it in frontmatter
  • tags can be specified (as in the example) and are in effect another way of adding tags to your page, you can achieve the same result by simply adding hashtags in the body of your document, e.g. #tag1 #tag2.

Silver Bullet also has the convention of using attributes starting with a $ for internal use. For instance, the sharing capability uses the $share attribute, and $disableDirectives: true has the special meaning of disabling 🔌 Directive processing on a page.