X-Git-Url: https://git.danieliu.xyz/?p=smdp.git;a=blobdiff_plain;f=sample.md;h=6e70ab8f984cbf1c7619de4ac3923cfe4b6498d9;hp=57abf3d4bfc754328a0860222b81ec7bbfc60bc4;hb=22055d604b1207680ded02d98715df5cafdf8648;hpb=b723e39232abc7632311eb06d7046c214ee05b51 diff --git a/sample.md b/sample.md index 57abf3d..6e70ab8 100644 --- a/sample.md +++ b/sample.md @@ -2,21 +2,35 @@ %author: visit1985 %date: 2014-09-22 -mdp -=== +-> mdp <- +========= -A command-line based markdown presentation tool. +-> 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 *---*. @@ -54,7 +68,7 @@ second-level ------------------------------------------------- -# Supported markdown formatting's +-> # Supported markdown formatting's <- Inline codes are surrounded with backticks. @@ -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,31 @@ 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. + +\~~~ {.numberLines} +\int main(int argc, char \*argv[]) { +\ printf("%s\\n", "Hello world!"); +\} +\~~~~~~~~~~~~~~~~~~ + +becomes + +~~~ {.numberLines} +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 +142,7 @@ becomes ------------------------------------------------- -# Supported markdown formatting's +-> # Supported markdown formatting <- Inline highlighting is supported as followed: @@ -119,7 +157,7 @@ _some_ *highlighted* _*text*_ ------------------------------------------------- -# Supported markdown formatting's +-> # Supported markdown formatting <- Backslashes force special markdown characters like *\**, *\_*, *#* and *>* to be printed as normal @@ -133,37 +171,90 @@ becomes ------------------------------------------------- -# Supported markdown formatting's +-> # Supported markdown formatting <- Leading *\** or *-* indicate lists. -TODO list -\* major 1 -\ \- minor 1.1 -\ \- detail 1.1.1 -\ \- detail 1.1.2 -\ \- minor 1.2 +list +\* major +\ - minor +\ - \*important\* +\ detail +\ - minor + +becomes + +list +* major + - minor + - *important* + detail + - minor + +------------------------------------------------- + +-> # 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. + +\-> # test <- +\-> ## test <- +\-> test +\-> \_\*test\*\_ <- becomes -TODO list -* major 1 - - minor 1.1 - - detail 1.1.1 - - detail 1.1.2 - - minor 1.2 +-> # test <- +-> ## test <- +-> test +-> _*test*_ <- ------------------------------------------------- -## More information about markdown +-> # Supported markdown formatting <- -can be found on +URL in pandoc style are supported: -_http://daringfireball.net/projects/markdown/_ +\[Google](http://www.google.com/) + +becomes + +[Google](http://www.google.com/) ------------------------------------------------- -# Support for UTF-8 special characters +-> ## More information about markdown <- + +can be found in the [markdown documentation](http://daringfireball.net/projects/markdown/). + +------------------------------------------------- + +-> # Support for UTF-8 special characters <- Here are some examples. @@ -177,7 +268,7 @@ upsilon = Ʊ, phi = ɸ ------------------------------------------------- -# Suspend your presentation for hands-on examples +-> # Suspend your presentation for hands-on examples <- Use *Ctrl + z* to suspend the presentation. @@ -185,7 +276,7 @@ Use *fg* to resume it. ------------------------------------------------- -# Convert your presentation to PDF +-> # Convert your presentation to PDF <- To publish your presentation later on, you may want to convert it to PDF. @@ -201,14 +292,9 @@ After installing them, you can simply type: ------------------------------------------------- -## Last words +-> ## Last words <- -I hope you like *mdp*. But be aware, that it is -still in alpha status. +I hope you like *mdp*. 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).