1 %title: mdp - Sample Presentation
8 -> A command-line based markdown presentation tool. <-
12 next slide *Enter*, *Space*, *Page Down*, *j*, *l*,
13 *Down Arrow*, *Right Arrow*
15 previous slide *Backspace*, *Page Up*, *h*, *k*,
16 *Up Arrow*, *Left Arrow*
21 first slide *Home*, *g*
24 -------------------------------------------------
26 -> # Supported markdown formatting <-
28 The input file is split into multiple slides by
29 horizontal rules (hr). A hr consisting of at
30 least 3 *\** or *-*. It can also contain spaces but
33 Each of these represents the start of a new slide.
37 \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
40 -------------------------------------------------
42 -> # Supported markdown formatting <-
44 First-level headers can be prefixed by single *#*
45 or underlined by *===*.
53 -------------------------------------------------
55 -> # Supported markdown formatting <-
57 Second-level headers can be prefixed by *##* or
69 -------------------------------------------------
71 -> # Supported markdown formatting's <-
73 Inline codes are surrounded with backticks.
75 C program starts with \`main()\`.
79 C program starts with `main()`.
81 -------------------------------------------------
83 -> # Supported markdown formatting <-
85 Code blocks are automatically detected by 4
86 spaces at the beginning of a line.
88 Tabs are automatically expanded to 4 spaces
89 while parsing the input.
91 \ int main(int argc, char \*argv[]) {
92 \ printf("%s\\n", "Hello world!");
97 int main(int argc, char *argv[]) {
98 printf("%s\n", "Hello world!");
101 -------------------------------------------------
103 -> # Supported markdown formatting <-
105 You can also use [pandoc](http://pandoc.org/demo/example9/pandocs-markdown.html)'s fenced code block extension.
106 Use at least three ~ chars to open and at least as many or
110 \int main(int argc, char \*argv[]) {
111 \ printf("%s\\n", "Hello world!");
118 int main(int argc, char \*argv[]) {
119 printf("%s\\n", "Hello world!");
123 Pandoc attributes (like ".numberlines" etc.) will be ignored
125 -------------------------------------------------
127 -> # Supported markdown formatting <-
129 Quotes are auto-detected by preceding *>*.
131 Multiple *>* are interpreted as nested quotes.
143 -------------------------------------------------
145 -> # Supported markdown formatting <-
147 Inline highlighting is supported as followed:
149 \- *\** colors text as red
150 \- *\_* underlines text
152 \_some\_ \*highlighted\* \_\*text\*\_
156 _some_ *highlighted* _*text*_
158 -------------------------------------------------
160 -> # Supported markdown formatting <-
162 Backslashes force special markdown characters
163 like *\**, *\_*, *#* and *>* to be printed as normal
172 -------------------------------------------------
174 -> # Supported markdown formatting <-
176 Leading *\** or *-* indicate lists.
194 -------------------------------------------------
196 -> # Supported markdown formatting <-
198 A single *\<br\>* or *^* in a line indicates mdp
199 to stop the output on that position.
201 This can be used to show bullet points
204 *\<br\>* is also not displayed in HTML converted
219 -------------------------------------------------
221 -> # Supported markdown formatting <-
223 Leading *->* indicates centering.
237 -------------------------------------------------
239 -> # Supported markdown formatting <-
241 URL in pandoc style are supported:
243 \[Google](http://www.google.com/)
247 [Google](http://www.google.com/)
249 -------------------------------------------------
251 -> ## More information about markdown <-
253 can be found in the [markdown documentation](http://daringfireball.net/projects/markdown/).
255 -------------------------------------------------
257 -> # Support for UTF-8 special characters <-
259 Here are some examples.
261 ae = ä, oe = ö, ue = ü, ss = ß
269 -------------------------------------------------
271 -> # Suspend your presentation for hands-on examples <-
273 Use *Ctrl + z* to suspend the presentation.
275 Use *fg* to resume it.
277 -------------------------------------------------
279 -> # Convert your presentation to PDF <-
281 To publish your presentation later on, you may
282 want to convert it to PDF.
284 This can be achieved by two additional tools:
286 \- *markdown* to convert to HTML
287 \- *wkhtmltopdf* to convert from HTML to PDF
289 After installing them, you can simply type:
291 $ markdown sample.md | wkhtmltopdf - sample.pdf
293 -------------------------------------------------
297 I hope you like *mdp*. But be aware that it is
298 still in alpha status.
300 If you observe strange behavior, feel free to
301 open an issue on [GitHub](https://github.com/visit1985/mdp).