diff --git a/readme.nml b/readme.nml deleted file mode 100644 index 916a4d4..0000000 --- a/readme.nml +++ /dev/null @@ -1,128 +0,0 @@ -@html.page_title = NML -- Readme -@html.title = NML -- The nice markup languge! -@'html.css = style.css - -@tex.main.fontsize = 9 -@tex.main.preamble = \usepackage{xcolor, amsmath} \\ -\definecolor{__color1}{HTML}{d5d5d5} \\ -\everymath{\color{__color1}\displaystyle} -@tex.main.block_prepend = \color{__color1} - -# Paragraphs - -Blank lines (or multiple `\\n`'s) create new paragraphs! - -```Plain Text, Example -First paragraph :: first '\n' - :: second '\n' -Second paragraph -``` - -# Lists - -Numbered lists `-`: - - first - - second - - third - -Unnumbered lists `\*`: - * A - * B - * C - -NML also supports list nesting of multiple kinds: - * first - * second - *- 2.1 - *- 2.2 - *-* even more nested - * third - -# Style - -NML supports markdown-based text styling: - * \*\*bold\*\* -> **bold** - * \*italic\* -> *italic* - * \__underline\__ -> __underline__ - * \`emphasis\` -> `emphasis` - -Some additionally supportd text styling - * \`\`inline code\`\` -> ``inline code`` - * \`\`C, int main()\`\` -> ``C, int main()`` - -# Code - -```[line_offset=64] C, Some C code -int main(int argc, char** argv) -{ - return 0; -} -``` - -# Lua kernel - -Simple kernel named `example`: -``Lua -@@ -`` -@@ - -Evaluating `!` from a kernel: `\%\%` - - * `\%<[example]! make_bold("Hello, World!")>\%` → %<[example]! make_bold("Hello, World!")>% - -# Latex - -## Support for inline maths: - * $\sum^{\infty}_{k=1} \frac{1}{k^2} = \frac{\pi^2}{6}$ - * $n! = \int_0^\infty t^n e^{-t} \text{ d}t$ - -# Graphs - -NML adds support for *Graphviz* graphs. - -[graph][ - width=600px, - layout=neato -] -digraph g { - bgcolor="transparent" - fontname="Helvetica,Arial,sans-serif" - node [fontname="Helvetica,Arial,sans-serif"] - edge [fontname="Helvetica,Arial,sans-serif"] - graph [fontsize=30 labelloc="t" label="" splines=true overlap=false rankdir = "LR"]; - "state0" [ style = "filled, bold" penwidth = 5 fillcolor = "white" fontname = "Courier New" shape = "Mrecord" label =<
State #0
(0) s -> •e $
(1) e -> •l '=' r
(2) e -> •r
(3) l -> •'*' r
(4) l -> •'n'
(5) r -> •l
> ]; - "state1" [ style = "filled" penwidth = 1 fillcolor = "white" fontname = "Courier New" shape = "Mrecord" label =<
State #1
(3) l -> •'*' r
(3) l -> '*' •r
(4) l -> •'n'
(5) r -> •l
> ]; - "state2" [ style = "filled" penwidth = 1 fillcolor = "white" fontname = "Courier New" shape = "Mrecord" label =<
State #2
(4) l -> 'n' •=$
> ]; - "state3" [ style = "filled" penwidth = 1 fillcolor = "white" fontname = "Courier New" shape = "Mrecord" label =<
State #3
(5) r -> l •=$
> ]; - "state4" [ style = "filled" penwidth = 1 fillcolor = "white" fontname = "Courier New" shape = "Mrecord" label =<
State #4
(3) l -> '*' r •=$
> ]; - "state5" [ style = "filled" penwidth = 1 fillcolor = "black" fontname = "Courier New" shape = "Mrecord" label =<
State #5
(0) s -> e •$
> ]; - "state6" [ style = "filled" penwidth = 1 fillcolor = "white" fontname = "Courier New" shape = "Mrecord" label =<
State #6
(1) e -> l •'=' r
(5) r -> l •$
> ]; - "state7" [ style = "filled" penwidth = 1 fillcolor = "white" fontname = "Courier New" shape = "Mrecord" label =<
State #7
(1) e -> l '=' •r
(3) l -> •'*' r
(4) l -> •'n'
(5) r -> •l
> ]; - "state8" [ style = "filled" penwidth = 1 fillcolor = "white" fontname = "Courier New" shape = "Mrecord" label =<
State #8
(1) e -> l '=' r •$
> ]; - "state9" [ style = "filled" penwidth = 1 fillcolor = "white" fontname = "Courier New" shape = "Mrecord" label =<
State #9
(2) e -> r •$
> ]; - state0 -> state5 [ penwidth = 5 fontsize = 28 fontcolor = "black" label = "e" ]; - state0 -> state6 [ penwidth = 5 fontsize = 28 fontcolor = "black" label = "l" ]; - state0 -> state9 [ penwidth = 5 fontsize = 28 fontcolor = "black" label = "r" ]; - state0 -> state1 [ penwidth = 1 fontsize = 14 fontcolor = "grey28" label = "'*'" ]; - state0 -> state2 [ penwidth = 1 fontsize = 14 fontcolor = "grey28" label = "'n'" ]; - state1 -> state1 [ penwidth = 1 fontsize = 14 fontcolor = "grey28" label = "'*'" ]; - state1 -> state4 [ penwidth = 5 fontsize = 28 fontcolor = "black" label = "r" ]; - state1 -> state2 [ penwidth = 1 fontsize = 14 fontcolor = "grey28" label = "'n'" ]; - state1 -> state3 [ penwidth = 5 fontsize = 28 fontcolor = "black" label = "l" ]; - state6 -> state7 [ penwidth = 1 fontsize = 14 fontcolor = "grey28" label = "'='" ]; - state7 -> state8 [ penwidth = 5 fontsize = 28 fontcolor = "black" label = "r" ]; - state7 -> state1 [ penwidth = 1 fontsize = 14 fontcolor = "grey28" label = "'*'" ]; - state7 -> state2 [ penwidth = 1 fontsize = 14 fontcolor = "grey28" label = "'n'" ]; - state7 -> state3 [ penwidth = 5 fontsize = 28 fontcolor = "black" label = "l" ]; -} -[/graph] -