diff options
Diffstat (limited to 'notes')
| -rw-r--r-- | notes/data.md | 38 | ||||
| -rw-r--r-- | notes/markup.md | 89 |
2 files changed, 127 insertions, 0 deletions
diff --git a/notes/data.md b/notes/data.md new file mode 100644 index 0000000..a240bf4 --- /dev/null +++ b/notes/data.md @@ -0,0 +1,38 @@ +# Data directory +│ +├─ users/ +│ │ +│ ├─ builtins/[name] (symlink) +│ │ +│ ├─ names/[name] (symlink) +│ │ +│ └─ id/[uuid] +│ +├─ roles/ +│ │ +│ ├─ builtins/[name] (symlink) +│ │ +│ ├─ names/[name] (symlink) +│ │ +│ └─ id/[uuid] +│ +├─ namespaces/ +│ │ +│ ├─ names/[name] (symlink) +│ │ +│ └─ id/[uuid]/ +│ │ +│ └─ pages/[name] (symlink) +│ +├─ pages/[uuid]/ +│ │ +│ ├─ current (symlink) +│ │ +│ └─ [timestamp] +│ +└─ media/ + │ + ├─ slugs/[url-slug] (symlink) + │ + └─ id/[uuid] + diff --git a/notes/markup.md b/notes/markup.md new file mode 100644 index 0000000..35c5d27 --- /dev/null +++ b/notes/markup.md @@ -0,0 +1,89 @@ +# Standard Markdown features + +- Italic +- Bold +- Links +- Images +- ATX Headings +- Setext Headings +- Bockquote +- Unordered lists +- Ordered lists +- Horizontal rule +- Inline code block +- Fenced code block +- Indented code block ??? (maybe not because they're cursed) + +# Commonmark +(these are all in standard, but we're going to specificaly implement their versions) + +- Ascii escapes +- Entity encoding +- HTML bocks + +# Github flavor + +- Tables (with alignment) +- To-do list +- Alerts + +# Other common extensions + +- Strikethrough ~~...~~, {--...--} +- Superscript ^...^ +- Subscript ~...~ +- Addition / suggestion {++...++} +- Highlight {==...==} +- Definition list (:) +- Abbreviation +- Inline math {$...$}, \\( \\) +- Block math $$$, \\[ \\] +- Table of contents {{TOC}} + +# StormMark + +This syntax extension primarily introduces block-level components useful +in defining page layout and navigation. + +## Alerts + +`#{alert:note}` (note, tip, important, warning, caution) + +## Figures + +The figure expression annotates a blockquote, appearing in the line +immediately before the opening of the blockquote. When used in this way, +the *entire blockquote* becomes the contents of the figure + +`#{fig:[X];[Y]}`, where `[X]` is a character indicating alignment, and `[Y]` +is an optional keyword indicating preferred figure width. For alignment: +- `>` right float +- `<` left float +- `=` block aligned (clears the space on either side) + +For size: +- `small` 15-25% of desktop width +- `medium` 25-35% of desktop width +- `large` varies, as large as the layout allows while keeping text + beside it + +**Note:** If the size is not included, then the `;` separator is +also optional + +Examples: + +```md +#{fig:>;small} +>  +> +> we can see from this image that blah blah +``` + +```md +#{fig:=;large} +>  +> +> this music video was posted on . . . +``` + + |