1 %title: mdp - Sample Presentation
8 -> A command-line based markdown presentation tool. <-
10 -------------------------------------------------
12 -> # Supported markdown formatting's <-
14 The input file is split into multiple slides by
15 horizontal rules (hr). A hr consisting of at
16 least 3 *\** or *-*. It can also contain spaces but
19 Each of these represents the start of a new slide
23 \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
26 -------------------------------------------------
28 -> # Supported markdown formatting's <-
30 First-level headers can be prefixed by single *#*
31 or underlined by *===*.
39 -------------------------------------------------
41 -> # Supported markdown formatting's <-
43 Second-level headers can be prefixed by *##* or
55 -------------------------------------------------
57 -> # Supported markdown formatting's <-
59 Inline codes are surrounded with backticks.
61 C program starts with \`main()\`.
65 C program starts with `main()`.
67 -------------------------------------------------
69 -> # Supported markdown formatting's <-
71 Code blocks are automatically detected by 4
72 spaces at the beginning of a line.
74 Tabs are automatically expanded to 4 spaces
75 while parsing the input.
77 \ int main(int argc, char \*argv[]) {
78 \ printf("%s\\n", "Hello world!");
83 int main(int argc, char *argv[]) {
84 printf("%s\n", "Hello world!");
87 -------------------------------------------------
89 -> # Supported markdown formatting's <-
91 Quotes are auto-detected by preceding *>*.
93 Multiple *>* are interpreted as nested quotes.
105 -------------------------------------------------
107 -> # Supported markdown formatting's <-
109 Inline highlighting is supported as followed:
111 \- *\** colors text as red
112 \- *\_* underlines text
114 \_some\_ \*highlighted\* \_\*text\*\_
118 _some_ *highlighted* _*text*_
120 -------------------------------------------------
122 -> # Supported markdown formatting's <-
124 Backslashes force special markdown characters
125 like *\**, *\_*, *#* and *>* to be printed as normal
134 -------------------------------------------------
136 -> # Supported markdown formatting's <-
138 Leading *\** or *-* indicate lists.
156 -------------------------------------------------
158 -> # Supported markdown formatting's <-
160 Leading *->* indicates centering.
174 -------------------------------------------------
176 -> # Supported markdown formatting's <-
178 URL in pandoc style are supported:
180 \[Google](http://www.google.com/)
184 [Google](http://www.google.com/)
186 -------------------------------------------------
188 -> ## More information about markdown <-
190 can be found in the [markdown documentation](http://daringfireball.net/projects/markdown/).
192 -------------------------------------------------
194 -> # Support for UTF-8 special characters <-
196 Here are some examples.
198 ae = ä, oe = ö, ue = ü, ss = ß
206 -------------------------------------------------
208 -> # Suspend your presentation for hands-on examples <-
210 Use *Ctrl + z* to suspend the presentation.
212 Use *fg* to resume it.
214 -------------------------------------------------
216 -> # Convert your presentation to PDF <-
218 To publish your presentation later on, you may
219 want to convert it to PDF.
221 This can be achieved by two additional tools:
223 \- *markdown* to convert to HTML
224 \- *wkhtmltopdf* to convert from HTML to PDF
226 After installing them, you can simply type:
228 $ markdown sample.md | wkhtmltopdf - sample.pdf
230 -------------------------------------------------
234 I hope you like *mdp*. But be aware, that it is
235 still in alpha status.
237 If you observe strange behavior, feel free to
238 open an issue on [GitHub](https://github.com/visit1985/mdp).