X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=sample.md;h=8f6b053ac5db7e696f23f345ed7041439ed7a2c0;hb=3e6d7001c4058b93281645e72ad1e223280b8589;hp=6009d47f7e4769c6f60a67691de47e21a9924f8c;hpb=af25ae81e6a51967017ddaac096d4e199f82b46a;p=smdp.git diff --git a/sample.md b/sample.md index 6009d47..8f6b053 100644 --- a/sample.md +++ b/sample.md @@ -7,16 +7,30 @@ -> A command-line based markdown presentation tool. <- +_Basic controls:_ + +next slide *Enter*, *Space*, *Page Down*, *j*, *l*, + *Down Arrow*, *Right Arrow* + +previous slide *Backspace*, *Page Up*, *h*, *k*, + *Up Arrow*, *Left Arrow* + +quit *q* +reload *r* +slide N *1..9* +first slide *Home*, *g* +last slide *End*, *G* + ------------------------------------------------- --> # Supported markdown formatting's <- +-> # Supported markdown formatting <- The input file is split into multiple slides by horizontal rules (hr). A hr consisting of at least 3 *\** or *-*. It can also contain spaces but no other characters. -Each of these represents the start of a new slide +Each of these represents the start of a new slide. \* \* \* \--- @@ -25,7 +39,7 @@ Each of these represents the start of a new slide ------------------------------------------------- --> # Supported markdown formatting's <- +-> # Supported markdown formatting <- First-level headers can be prefixed by single *#* or underlined by *===*. @@ -38,7 +52,7 @@ becomes ------------------------------------------------- --> # Supported markdown formatting's <- +-> # Supported markdown formatting <- Second-level headers can be prefixed by *##* or underlined by *---*. @@ -66,7 +80,7 @@ C program starts with `main()`. ------------------------------------------------- --> # Supported markdown formatting's <- +-> # Supported markdown formatting <- Code blocks are automatically detected by 4 spaces at the beginning of a line. @@ -86,7 +100,33 @@ becomes ------------------------------------------------- --> # Supported markdown formatting's <- +-> # Supported markdown formatting <- + +You can also use [pandoc](http://pandoc.org/demo/example9/pandocs-markdown.html)'s fenced code block extension. +Use at least three ~ chars to open and at least as many or +more ~ for closing. + +~~~~~ +~~~ +int main(int argc, char \*argv[]) { + printf("%s\\n", "Hello world!"); +} +~~~ +~~~~~~~ + +becomes + +~~~ +int main(int argc, char \*argv[]) { + printf("%s\\n", "Hello world!"); +} +~~~ + +Pandoc attributes (like ".numberlines" etc.) will be ignored + +------------------------------------------------- + +-> # Supported markdown formatting <- Quotes are auto-detected by preceding *>*. @@ -104,7 +144,7 @@ becomes ------------------------------------------------- --> # Supported markdown formatting's <- +-> # Supported markdown formatting <- Inline highlighting is supported as followed: @@ -119,7 +159,7 @@ _some_ *highlighted* _*text*_ ------------------------------------------------- --> # Supported markdown formatting's <- +-> # Supported markdown formatting <- Backslashes force special markdown characters like *\**, *\_*, *#* and *>* to be printed as normal @@ -133,7 +173,7 @@ becomes ------------------------------------------------- --> # Supported markdown formatting's <- +-> # Supported markdown formatting <- Leading *\** or *-* indicate lists. @@ -155,7 +195,32 @@ list ------------------------------------------------- --> # Supported markdown formatting's <- +-> # Supported markdown formatting <- + +A single *\* or *^* in a line indicates mdp +to stop the output on that position. + +This can be used to show bullet points +line by line. + +*\* is also not displayed in HTML converted +output. + +Agenda +
+* major +
+ * minor +
+* major + ^ + * minor + ^ + * detail + +------------------------------------------------- + +-> # Supported markdown formatting <- Leading *->* indicates centering. @@ -173,23 +238,21 @@ becomes ------------------------------------------------- --> # Supported markdown formatting's <- +-> # Supported markdown formatting <- -URL in John MacFarlane's Pandoc style are supported : +URL in pandoc style are supported: -\[GitHub repository for mdp](https://github.com/visit1985/mdp) -\[Google](google.com) +\[Google](http://www.google.com/) + +becomes -[GitHub repository for mdp](https://github.com/visit1985/mdp) -[Google](google.com) +[Google](http://www.google.com/) ------------------------------------------------- -> ## More information about markdown <- -can be found on - -_http://daringfireball.net/projects/markdown/_ +can be found in the [markdown documentation](http://daringfireball.net/projects/markdown/). ------------------------------------------------- @@ -233,12 +296,8 @@ After installing them, you can simply type: -> ## Last words <- -I hope you like *mdp*. But be aware, that it is +I hope you like *mdp*. But be aware that it is still in alpha status. If you observe strange behavior, feel free to -open an issue on GitHub: - -_https://github.com/visit1985/mdp_ - - +open an issue on [GitHub](https://github.com/visit1985/mdp).