X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=sample.md;h=bf24ce0db7c0d6e2419ab579d4e0598b1d4d31b8;hb=96f4804a413b591d74505eacfa621604b56f6d5f;hp=8cea5d6b3ae5a25c2daf2a19806f1b4215cef893;hpb=6edf0543111ac7f119c0255ae254159d9508f770;p=smdp.git diff --git a/sample.md b/sample.md index 8cea5d6..bf24ce0 100644 --- a/sample.md +++ b/sample.md @@ -1,15 +1,15 @@ %title: mdp - Sample Presentation -%author: Michael Göhler -%date: 2014-09-18 +%author: visit1985 +%date: 2014-09-22 -mdp -=== +-> mdp <- +========= -A command-line based markdown presentation tool. +-> A command-line based markdown presentation tool. <- ------------------------------------------------- -# Supported markdown formatting's +-> # Supported markdown formatting's <- The input file is split into multiple slides by horizontal rules (hr). A hr consisting of at @@ -25,7 +25,7 @@ Each of these represents the start of a new slide ------------------------------------------------- -# Supported markdown formatting's +-> # Supported markdown formatting's <- First-level headers can be prefixed by single *#* or underlined by *===*. @@ -38,7 +38,7 @@ becomes ------------------------------------------------- -# Supported markdown formatting's +-> # Supported markdown formatting's <- Second-level headers can be prefixed by *##* or underlined by *---*. @@ -54,7 +54,7 @@ second-level ------------------------------------------------- -# Supported markdown formatting's +-> # Supported markdown formatting's <- Inline codes are surrounded with backticks. @@ -66,7 +66,7 @@ C program starts with `main()`. ------------------------------------------------- -# Supported markdown formatting's +-> # Supported markdown formatting's <- Code blocks are automatically detected by 4 spaces at the beginning of a line. @@ -86,7 +86,7 @@ becomes ------------------------------------------------- -# Supported markdown formatting's +-> # Supported markdown formatting's <- Quotes are auto-detected by preceding *>*. @@ -104,12 +104,12 @@ becomes ------------------------------------------------- -# Supported markdown formatting's +-> # Supported markdown formatting's <- Inline highlighting is supported as followed: -- *\** colors text as red -- *\_* underlines text +\- *\** colors text as red +\- *\_* underlines text \_some\_ \*highlighted\* \_\*text\*\_ @@ -119,7 +119,7 @@ _some_ *highlighted* _*text*_ ------------------------------------------------- -# Supported markdown formatting's +-> # Supported markdown formatting's <- Backslashes force special markdown characters like *\**, *\_*, *#* and *>* to be printed as normal @@ -133,15 +133,65 @@ becomes ------------------------------------------------- -## More information about markdown +-> # Supported markdown formatting's <- -can be found on +Leading *\** or *-* indicate lists. -_http://daringfireball.net/projects/markdown/_ +list +\* major +\ - minor +\ - \*important\* +\ detail +\ - minor + +becomes + +list +* major + - minor + - *important* + detail + - minor + +------------------------------------------------- + +-> # Supported markdown formatting's <- + +Leading *->* indicates centering. + +\-> # test <- +\-> ## test <- +\-> test +\-> \_\*test\*\_ <- + +becomes + +-> # test <- +-> ## test <- +-> test +-> _*test*_ <- + +------------------------------------------------- + +-> # Supported markdown formatting's <- + +URL in pandoc style are supported: + +\[Google](http://www.google.com/) + +becomes + +[Google](http://www.google.com/) + +------------------------------------------------- + +-> ## More information about markdown <- + +can be found in the [markdown documentation](http://daringfireball.net/projects/markdown/). ------------------------------------------------- -# Support for UTF-8 special characters +-> # Support for UTF-8 special characters <- Here are some examples. @@ -155,7 +205,7 @@ upsilon = Ʊ, phi = ɸ ------------------------------------------------- -# Suspend your presentation for hands-on examples +-> # Suspend your presentation for hands-on examples <- Use *Ctrl + z* to suspend the presentation. @@ -163,14 +213,28 @@ Use *fg* to resume it. ------------------------------------------------- -## Last words +-> # Convert your presentation to PDF <- + +To publish your presentation later on, you may +want to convert it to PDF. + +This can be achieved by two additional tools: + +\- *markdown* to convert to HTML +\- *wkhtmltopdf* to convert from HTML to PDF + +After installing them, you can simply type: + + $ markdown sample.md | wkhtmltopdf - sample.pdf + +------------------------------------------------- + +-> ## Last words <- 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).