extend sample.md so it looks more like a documentation
[smdp.git] / sample.md
1 %title: mdp - Sample Presentation
2 %author: Michael Göhler
3 %date: 2014-09-18
4
5 mdp
6 ===
7
8 A command-line based markdown presentation tool.
9
10 -------------------------------------------------
11
12 # Supported markdown formatting's
13
14 First-level headers can be prefixed by single *#*
15 or underlined by *===*.
16
17 \# first-level
18
19 becomes
20
21 # first-level
22
23 -------------------------------------------------
24
25 # Supported markdown formatting's
26
27 Second-level headers can be prefixed by *##* or
28 underlined by *---*.
29
30 second-level
31 \------------
32
33 becomes
34
35 second-level
36 ------------
37
38
39 -------------------------------------------------
40
41 # Supported markdown formatting's
42
43 Code blocks are automatically detected by 4
44 spaces at the beginning of a line.
45
46 Tabs are automatically expanded to 4 spaces
47 while parsing the input.
48
49 \    int main(int argc, char \*argv[]) {
50 \        printf("%s\\n", "Hello world!");
51 \    }
52
53 becomes
54
55     int main(int argc, char *argv[]) {
56         printf("%s\n", "Hello world!");
57     }
58
59 -------------------------------------------------
60
61 # Supported markdown formatting's
62
63 Quotes are auto-detected by preceding *>*.
64
65 Multiple *>* are interpreted as nested quotes.
66
67 \> quote
68 \>> nested quote 1
69 \> > nested quote 2
70
71 becomes
72
73 > quote
74 >> nested quote 1
75 > > nested quote 2
76
77 -------------------------------------------------
78
79 # Supported markdown formatting's
80
81 Inline highlighting is supported as followed:
82
83 - *\** colors text as red
84 - *\_* underlines text
85
86 \_some\_ \*highlighted\* \_\*text\*\_
87
88 becomes
89
90 _some_ *highlighted* _*text*_
91
92 -------------------------------------------------
93
94 # Supported markdown formatting's
95
96 Backslashes force special markdown characters
97 like *\**, *\_*, *#* and *>* to be printed as normal
98 characters.
99
100 \\\*special\\\*
101
102 becomes
103
104 \*special\*
105
106 -------------------------------------------------
107
108 ## More information about markdown
109
110 can be found on
111
112 _http://daringfireball.net/projects/markdown/_
113
114 -------------------------------------------------
115
116 # Support for UTF-8 special characters
117
118 Here are some examples.
119
120 ae = ä, oe = ö, ue = ü, ss = ß
121 upsilon = Ʊ, phi = ɸ
122
123 ▛▀▀▀▀▀▀▀▀▀▜
124 ▌rectangle▐
125 ▙▄▄▄▄▄▄▄▄▄▟
126
127
128 -------------------------------------------------
129
130 # Suspend your presentation for hands-on examples
131
132 Use *Ctrl + z* to suspend the presentation.
133
134 Use *fg* to resume it.
135
136 -------------------------------------------------
137
138 ## Last words
139
140 I hope you like *mdp*. But be aware, that it is
141 still in alpha status.
142
143 If you observe strange behavior, feel free to
144 open an issue on GitHub:
145
146 _https://github.com/visit1985/mdp_
147