Replace ((void*)0) with NULL.
[smdp.git] / sample.md
1 %title: mdp - Sample Presentation
2 %author: visit1985
3 %date: 2014-09-22
4
5 mdp
6 ===
7
8 A command-line based markdown presentation tool.
9
10 -------------------------------------------------
11
12 # Supported markdown formatting's
13
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
17 no other characters.
18
19 Each of these represents the start of a new slide
20
21 \* \* \*
22 \---
23 \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
24 \- - -
25
26 -------------------------------------------------
27
28 # Supported markdown formatting's
29
30 First-level headers can be prefixed by single *#*
31 or underlined by *===*.
32
33 \# first-level
34
35 becomes
36
37 # first-level
38
39 -------------------------------------------------
40
41 # Supported markdown formatting's
42
43 Second-level headers can be prefixed by *##* or
44 underlined by *---*.
45
46 second-level
47 \------------
48
49 becomes
50
51 second-level
52 ------------
53
54
55 -------------------------------------------------
56
57 # Supported markdown formatting's
58
59 Inline codes are surrounded with backticks.
60
61 C program starts with \`main()\`.
62
63 becomes
64
65 C program starts with `main()`.
66
67 -------------------------------------------------
68
69 # Supported markdown formatting's
70
71 Code blocks are automatically detected by 4
72 spaces at the beginning of a line.
73
74 Tabs are automatically expanded to 4 spaces
75 while parsing the input.
76
77 \    int main(int argc, char \*argv[]) {
78 \        printf("%s\\n", "Hello world!");
79 \    }
80
81 becomes
82
83     int main(int argc, char *argv[]) {
84         printf("%s\n", "Hello world!");
85     }
86
87 -------------------------------------------------
88
89 # Supported markdown formatting's
90
91 Quotes are auto-detected by preceding *>*.
92
93 Multiple *>* are interpreted as nested quotes.
94
95 \> quote
96 \>> nested quote 1
97 \> > nested quote 2
98
99 becomes
100
101 > quote
102 >> nested quote 1
103 > > nested quote 2
104
105 -------------------------------------------------
106
107 # Supported markdown formatting's
108
109 Inline highlighting is supported as followed:
110
111 \- *\** colors text as red
112 \- *\_* underlines text
113
114 \_some\_ \*highlighted\* \_\*text\*\_
115
116 becomes
117
118 _some_ *highlighted* _*text*_
119
120 -------------------------------------------------
121
122 # Supported markdown formatting's
123
124 Backslashes force special markdown characters
125 like *\**, *\_*, *#* and *>* to be printed as normal
126 characters.
127
128 \\\*special\\\*
129
130 becomes
131
132 \*special\*
133
134 -------------------------------------------------
135
136 # Supported markdown formatting's
137
138 Leading *\** or *-* indicate lists.
139
140 TODO list
141 \* major 1
142 \    \- minor 1.1
143 \        \- detail 1.1.1
144 \        \- detail 1.1.2
145 \    \- minor 1.2
146
147 becomes
148
149 TODO list
150 * major 1
151     - minor 1.1
152         - detail 1.1.1
153         - detail 1.1.2
154     - minor 1.2
155
156 -------------------------------------------------
157
158 ## More information about markdown
159
160 can be found on
161
162 _http://daringfireball.net/projects/markdown/_
163
164 -------------------------------------------------
165
166 # Support for UTF-8 special characters
167
168 Here are some examples.
169
170 ae = ä, oe = ö, ue = ü, ss = ß
171 upsilon = Ʊ, phi = ɸ
172
173 ▛▀▀▀▀▀▀▀▀▀▜
174 ▌rectangle▐
175 ▙▄▄▄▄▄▄▄▄▄▟
176
177
178 -------------------------------------------------
179
180 # Suspend your presentation for hands-on examples
181
182 Use *Ctrl + z* to suspend the presentation.
183
184 Use *fg* to resume it.
185
186 -------------------------------------------------
187
188 # Convert your presentation to PDF
189
190 To publish your presentation later on, you may
191 want to convert it to PDF.
192
193 This can be achieved by two additional tools:
194
195 \- *markdown* to convert to HTML
196 \- *wkhtmltopdf* to convert from HTML to PDF
197
198 After installing them, you can simply type:
199
200     $ markdown sample.md | wkhtmltopdf - sample.pdf
201
202 -------------------------------------------------
203
204 ## Last words
205
206 I hope you like *mdp*. But be aware, that it is
207 still in alpha status.
208
209 If you observe strange behavior, feel free to
210 open an issue on GitHub:
211
212 _https://github.com/visit1985/mdp_
213
214