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
111 int main(int argc, char \*argv[]) {
112 printf("%s\\n", "Hello world!");
120 int main(int argc, char \*argv[]) {
121 printf("%s\\n", "Hello world!");
125 Pandoc attributes (like ".numberlines" etc.) will be ignored
127 -------------------------------------------------
129 -> # Supported markdown formatting <-
131 Quotes are auto-detected by preceding *>*.
133 Multiple *>* are interpreted as nested quotes.
145 -------------------------------------------------
147 -> # Supported markdown formatting <-
149 Inline highlighting is supported as followed:
151 \- *\** colors text as red
152 \- *\_* underlines text
154 \_some\_ \*highlighted\* \_\*text\*\_
158 _some_ *highlighted* _*text*_
160 -------------------------------------------------
162 -> # Supported markdown formatting <-
164 Backslashes force special markdown characters
165 like *\**, *\_*, *#* and *>* to be printed as normal
174 -------------------------------------------------
176 -> # Supported markdown formatting <-
178 Leading *\** or *-* indicate lists.
196 -------------------------------------------------
198 -> # Supported markdown formatting <-
200 A single *\<br\>* or *^* in a line indicates mdp
201 to stop the output on that position.
203 This can be used to show bullet points
206 *\<br\>* is also not displayed in HTML converted
221 -------------------------------------------------
223 -> # Supported markdown formatting <-
225 Leading *->* indicates centering.
239 -------------------------------------------------
241 -> # Supported markdown formatting <-
243 URL in pandoc style are supported:
245 \[Google](http://www.google.com/)
249 [Google](http://www.google.com/)
251 -------------------------------------------------
253 -> ## More information about markdown <-
255 can be found in the [markdown documentation](http://daringfireball.net/projects/markdown/).
257 -------------------------------------------------
259 -> # Support for UTF-8 special characters <-
261 Here are some examples.
263 ae = ä, oe = ö, ue = ü, ss = ß
271 -------------------------------------------------
273 -> # Suspend your presentation for hands-on examples <-
275 Use *Ctrl + z* to suspend the presentation.
277 Use *fg* to resume it.
279 -------------------------------------------------
281 -> # Convert your presentation to PDF <-
283 To publish your presentation later on, you may
284 want to convert it to PDF.
286 This can be achieved by two additional tools:
288 \- *markdown* to convert to HTML
289 \- *wkhtmltopdf* to convert from HTML to PDF
291 After installing them, you can simply type:
293 $ markdown sample.md | wkhtmltopdf - sample.pdf
295 -------------------------------------------------
299 I hope you like *mdp*. But be aware that it is
300 still in alpha status.
302 If you observe strange behavior, feel free to
303 open an issue on [GitHub](https://github.com/visit1985/mdp).