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 Leading *->* indicates centering.
188 -------------------------------------------------
190 -> # Supported markdown formatting <-
192 URL in pandoc style are supported:
194 \[Google](http://www.google.com/)
198 [Google](http://www.google.com/)
200 -------------------------------------------------
202 -> ## More information about markdown <-
204 can be found in the [markdown documentation](http://daringfireball.net/projects/markdown/).
206 -------------------------------------------------
208 -> # Support for UTF-8 special characters <-
210 Here are some examples.
212 ae = ä, oe = ö, ue = ü, ss = ß
220 -------------------------------------------------
222 -> # Suspend your presentation for hands-on examples <-
224 Use *Ctrl + z* to suspend the presentation.
226 Use *fg* to resume it.
228 -------------------------------------------------
230 -> # Convert your presentation to PDF <-
232 To publish your presentation later on, you may
233 want to convert it to PDF.
235 This can be achieved by two additional tools:
237 \- *markdown* to convert to HTML
238 \- *wkhtmltopdf* to convert from HTML to PDF
240 After installing them, you can simply type:
242 $ markdown sample.md | wkhtmltopdf - sample.pdf
244 -------------------------------------------------
248 I hope you like *mdp*. But be aware that it is
249 still in alpha status.
251 If you observe strange behavior, feel free to
252 open an issue on [GitHub](https://github.com/visit1985/mdp).