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 spaces
86 at the beginning of a line.
88 Tabs are automatically expanded to 4 spaces while
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
106 extension. Use at least three ~ chars to open and
107 at least as many or more ~ for closing.
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.)
126 -------------------------------------------------
128 -> # Supported markdown formatting <-
130 Quotes are auto-detected by preceding *>*.
132 Multiple *>* are interpreted as nested quotes.
144 -------------------------------------------------
146 -> # Supported markdown formatting <-
148 Inline highlighting is supported as followed:
150 \- *\** colors text as red
151 \- *\_* underlines text
153 \_some\_ \*highlighted\* \_\*text\*\_
157 _some_ *highlighted* _*text*_
159 -------------------------------------------------
161 -> # Supported markdown formatting <-
163 Backslashes force special markdown characters
164 like *\**, *\_*, *#* and *>* to be printed as
173 -------------------------------------------------
175 -> # Supported markdown formatting <-
177 Leading *\** or *-* indicate lists.
195 -------------------------------------------------
197 -> # Supported markdown formatting <-
199 A single *\<br\>* or *^* in a line indicates mdp
200 to stop the output on that position.
202 This can be used to show bullet points
205 *\<br\>* is also not displayed in HTML converted
220 -------------------------------------------------
222 -> # Supported markdown formatting <-
224 Leading *->* indicates centering.
238 -------------------------------------------------
240 -> # Supported markdown formatting <-
242 URL in pandoc style are supported:
244 \[Google](http://www.google.com/)
248 [Google](http://www.google.com/)
250 -------------------------------------------------
252 -> ## More information about markdown <-
254 can be found in the [markdown documentation](http://daringfireball.net/projects/markdown/).
256 -------------------------------------------------
258 -> # Support for UTF-8 special characters <-
260 Here are some examples.
262 ae = ä, oe = ö, ue = ü, ss = ß
270 -------------------------------------------------
272 -> # Suspend your presentation for hands-on examples <-
274 Use *Ctrl + z* to suspend the presentation.
276 Use *fg* to resume it.
278 -------------------------------------------------
280 -> # Convert your presentation to PDF <-
282 To publish your presentation later on, you may
283 want to convert it to PDF.
285 This can be achieved by two additional tools:
287 \- *markdown* to convert to HTML
288 \- *wkhtmltopdf* to convert from HTML to PDF
290 After installing them, you can simply type:
292 $ markdown sample.md | wkhtmltopdf - sample.pdf
294 -------------------------------------------------
298 I hope you like *mdp*.
300 If you observe strange behavior, feel free to
301 open an issue on [GitHub](https://github.com/visit1985/mdp).