summary refs log tree commit diff
path: root/notes/markup.md
blob: 35c5d279ebec750ee0ed89ba2459e8cba545abd0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
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}
> ![something](path to image)
> 
> we can see from this image that blah blah
```

```md
#{fig:=;large}
> ![some video](path to video)
> 
> this music video was posted on . . .
```