Story Inscription Format

Story Inscriptions utilize Markdown as the formal language for formatting text, with the ability to extend if needed.

Schema

Story Inscriptions are markdown text blobs, supporting both portions of Markdown: Frontmatter and Content.

Frontmatter

Frontmatter is a JSON blob, with curly braces starting and ending on their own lines (as shown below). Any structured data can be put in here. Transient Labs uses namespacing for specific products, such as T.R.A.C.E.

JSON was chosen as it is the most secure and easiest to serialize across web frameworks. YAML is not secure enough in our opinion and TOML is harder to work with. There is no standard way to specify JSON Frontmatter, however, the method chosen here is widely supported across programming languages (Javascript, Python, Go).

Content

Content is markdown text that should be parsed and escaped to avoid XSS and other attack vectors. This guide shows what is accepted as Markdown syntax: https://www.markdownguide.org/basic-syntax/

Example

{
  "data": "some json data in Frontmatter"
}
# Markdown Content starts here!
You can write whatever you want down here!