Frontmatter
Frontmatter is valid YAML between triple-dashed (---) lines that is the first thing in the file.
Example Frontmatter
---
id: ezbbhbn8i8thheiak1ng2vq
title: "Note title"
desc: ''
updated: 1685861421330
---
Above this line is the frontmatter. This line and below is the markdown content.
Required fields
id
The ID in frontmatter is the minimum value needed to deem a markdown file as a parseable note.
Format
---
id: <globally-unique-string>
---
---
id: 5wq691vs7bkjf59xdsdsadf
---
Why is id required?
Stable links
Without an id, whenever you publish (web view), you would publish with the file name. This makes the links very brittle if any refactoring occurs. We want to allow linking to published notes in a much more stable fashion, so you can refactor note hierarchies without breaking links to your published views.
Long-term metadata
A globally unique, stable identifier tied to the file allows us to store metadata about that note, such as Visit History.
Optional:
title
The frontmatter note title is stored within the FrontMatter of a note and is used to set a particular value for Note Title (Concept).
Optional field: When not set, the title is inferred from the note name (last segment, with - replaced by spaces and title-cased).
An example note title set in frontmatter:
---
title: Note Title in Frontmatter
...
---
The note title use case is to have a display name for a note in visualizations and previews that is different from its file name.
Notes
Not to be confused with Note Name
desc (description)
Description field in the Frontmatter of the note.
---
desc: ''
---
Each note in Thorg must have valid FrontMatter.
FrontMatter is a YAML value at the beginning of the note surrounded by ---.
An example of basic valid FrontMatter:
---
id: ezbbhbn8i8thheiak1ng2vq
title: Note Must Have a Valid Frontmatter
desc: ''
updated: 1685861421330
---
Frontmatter Documentation:
Children
Backlinks