%title: mdp - Sample Presentation
%author: visit1985
-%date: 2014-09-22
+%date: 2016-02-07
-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.
\* \* \*
\---
-------------------------------------------------
-# Supported markdown formatting's
+-> # Supported markdown formatting <-
First-level headers can be prefixed by single *#*
or underlined by *===*.
-------------------------------------------------
-# Supported markdown formatting's
+-> # Supported markdown formatting <-
Second-level headers can be prefixed by *##* or
underlined by *---*.
-------------------------------------------------
-# Supported markdown formatting's
+-> # Supported markdown formatting's <-
Inline codes are surrounded with backticks.
-------------------------------------------------
-# Supported markdown formatting's
+-> # Supported markdown formatting <-
-Code blocks are automatically detected by 4
-spaces at the beginning of a line.
+Code blocks are automatically detected by 4 spaces
+at the beginning of a line.
-Tabs are automatically expanded to 4 spaces
-while parsing the input.
+Tabs are automatically expanded to 4 spaces while
+parsing the input.
\ int main(int argc, char \*argv[]) {
\ printf("%s\\n", "Hello world!");
-------------------------------------------------
-# Supported markdown formatting's
+-> # Supported markdown formatting <-
+
+You can also use [pandoc](https://pandoc.org/MANUAL.html#fenced-code-blocks)'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 <-
+
+You can also use [github](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) flavored markdown's
+code block. Use at least three backticks to open
+and at least as many or more backticks 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!");
+}
+```
+
+Language hint will be ignored
+
+-------------------------------------------------
+
+-> # Supported markdown formatting <-
Quotes are auto-detected by preceding *>*.
-------------------------------------------------
-# Supported markdown formatting's
+-> # Supported markdown formatting <-
Inline highlighting is supported as followed:
-------------------------------------------------
-# Supported markdown formatting's
+-> # Supported markdown formatting <-
Backslashes force special markdown characters
-like *\**, *\_*, *#* and *>* to be printed as normal
-characters.
+like *\**, *\_*, *#* and *>* to be printed as
+normal characters.
\\\*special\\\*
-------------------------------------------------
-# Supported markdown formatting's
+-> # Supported markdown formatting <-
-The leading stars or minuses make list.
+Leading *\** or *-* indicate lists.
-TODO list:
-\* TODO major 1
-\ \- TODO minor 1.1
-\ \- Detail 1.1.1
-\ \- Detail 1.1.2
-\ \- TODO minor 1.2
-\* TODO major 2
-\* TODO major 3
-\ \* TODO minor 3.1
-\ \* TODO minor 3.2
+list
+\* major
+\ - minor
+\ - \*important\*
+\ detail
+\ - minor
becomes
-TODO list:
-* TODO major 1
- - TODO minor 1.1
- - Detail 1.1.1
- - Detail 1.1.2
- - TODO minor 1.2
-* TODO major 2
-* TODO major 3
- * TODO minor 3.1
- * TODO minor 3.2
+list
+* major
+ - minor
+ - *important*
+ detail
+ - minor
-------------------------------------------------
-## More information about markdown
+-> # Supported markdown formatting <-
+
+A single *\<br\>* or *^* in a line indicates mdp
+to stop the output on that position.
+
+This can be used to show bullet points
+line by line.
-can be found on
+*\<br\>* is also not displayed in HTML converted
+output.
-_http://daringfireball.net/projects/markdown/_
+Agenda
+<br>
+* major
+<br>
+ * minor
+<br>
+* major
+ ^
+ * minor
+ ^
+ * detail
-------------------------------------------------
-# Support for UTF-8 special characters
+-> # Supported markdown formatting <-
+
+Leading *->* indicates centering.
+
+\-> # test <-
+\-> ## test <-
+\-> test
+\-> \_\*test\*\_ <-
+
+becomes
+
+-> # test <-
+-> ## test <-
+-> test
+-> _*test*_ <-
+
+-------------------------------------------------
+
+-> # Supported markdown formatting <-
+
+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 <-
Here are some examples.
-------------------------------------------------
-# Suspend your presentation for hands-on examples
+-> # Suspend your presentation for hands-on examples <-
Use *Ctrl + z* to suspend the presentation.
-------------------------------------------------
-# Convert your presentation to PDF
+-> # Convert your presentation to PDF <-
To publish your presentation later on, you may
want to convert it to PDF.
-------------------------------------------------
-## 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).
