X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=sample.md;h=5a11d1a5e8d6c1c0b576fec57b41377e57ea1651;hb=4b8ad1b3b464836eca2e876dd418a8e8d87bd721;hp=6009d47f7e4769c6f60a67691de47e21a9924f8c;hpb=af25ae81e6a51967017ddaac096d4e199f82b46a;p=smdp.git diff --git a/sample.md b/sample.md index 6009d47..5a11d1a 100644 --- a/sample.md +++ b/sample.md @@ -7,9 +7,23 @@ -> 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 @@ -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,7 @@ becomes ------------------------------------------------- --> # Supported markdown formatting's <- +-> # Supported markdown formatting <- Quotes are auto-detected by preceding *>*. @@ -104,7 +118,7 @@ becomes ------------------------------------------------- --> # Supported markdown formatting's <- +-> # Supported markdown formatting <- Inline highlighting is supported as followed: @@ -119,7 +133,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 +147,7 @@ becomes ------------------------------------------------- --> # Supported markdown formatting's <- +-> # Supported markdown formatting <- Leading *\** or *-* indicate lists. @@ -155,7 +169,7 @@ list ------------------------------------------------- --> # Supported markdown formatting's <- +-> # Supported markdown formatting <- Leading *->* indicates centering. @@ -173,23 +187,21 @@ becomes ------------------------------------------------- --> # Supported markdown formatting's <- +-> # Supported markdown formatting <- + +URL in pandoc style are supported: -URL in John MacFarlane's Pandoc style are supported : +\[Google](http://www.google.com/) -\[GitHub repository for mdp](https://github.com/visit1985/mdp) -\[Google](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 +245,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).