diff --git a/Custom-Syntax.md b/Custom-Syntax.md new file mode 100644 index 0000000..8169e94 --- /dev/null +++ b/Custom-Syntax.md @@ -0,0 +1,64 @@ +# Custom Syntax + +This document highlights custom Markdown syntax that is implemented (or is planned to be implemented) throughout the User Guide Markdown as well as the parser. + +All of these custom syntax will result in DOM elements with specific styling / attributes via our parser. + +## Blocks + +### Basics + +Each "block" is either a start or end block. + +- Custom syntax that is the start of a block begins with `syntax.start` +- Custom syntax that is the end of a block **is** `syntax.end` + +Each block syntax begins with `{{ ` and ends with `}}`. + +**Example:** + +``` markdown +{{ syntax.start:float-left }} +Content +{{ syntax.end }} +``` + +### Parsing + +When parsing the syntax as DOM elements: +1. `syntax.start` blocks are parsed as `