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 Quotes are auto-detected by preceding *>*.
107 Multiple *>* are interpreted as nested quotes.
119 -------------------------------------------------
121 -> # Supported markdown formatting <-
123 Inline highlighting is supported as followed:
125 \- *\** colors text as red
126 \- *\_* underlines text
128 \_some\_ \*highlighted\* \_\*text\*\_
132 _some_ *highlighted* _*text*_
134 -------------------------------------------------
136 -> # Supported markdown formatting <-
138 Backslashes force special markdown characters
139 like *\**, *\_*, *#* and *>* to be printed as normal
148 -------------------------------------------------
150 -> # Supported markdown formatting <-
152 Leading *\** or *-* indicate lists.
170 -------------------------------------------------
172 -> # Supported markdown formatting <-
174 A single *\<br\>* or *^* in a line indicates mdp
175 to stop the output on that position.
177 This can be used to show bullet points
180 *\<br\>* is also not displayed in HTML converted
195 -------------------------------------------------
197 -> # Supported markdown formatting <-
199 Leading *->* indicates centering.
213 -------------------------------------------------
215 -> # Supported markdown formatting <-
217 URL in pandoc style are supported:
219 \[Google](http://www.google.com/)
223 [Google](http://www.google.com/)
225 -------------------------------------------------
227 -> ## More information about markdown <-
229 can be found in the [markdown documentation](http://daringfireball.net/projects/markdown/).
231 -------------------------------------------------
233 -> # Support for UTF-8 special characters <-
235 Here are some examples.
237 ae = ä, oe = ö, ue = ü, ss = ß
245 -------------------------------------------------
247 -> # Suspend your presentation for hands-on examples <-
249 Use *Ctrl + z* to suspend the presentation.
251 Use *fg* to resume it.
253 -------------------------------------------------
255 -> # Convert your presentation to PDF <-
257 To publish your presentation later on, you may
258 want to convert it to PDF.
260 This can be achieved by two additional tools:
262 \- *markdown* to convert to HTML
263 \- *wkhtmltopdf* to convert from HTML to PDF
265 After installing them, you can simply type:
267 $ markdown sample.md | wkhtmltopdf - sample.pdf
269 -------------------------------------------------
273 I hope you like *mdp*. But be aware that it is
274 still in alpha status.
276 If you observe strange behavior, feel free to
277 open an issue on [GitHub](https://github.com/visit1985/mdp).