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 The leading stars or minuses make list.
 139
 140 TODO list:
 141 \* TODO major 1
 142 \    \- TODO minor 1.1
 143 \        \- Detail 1.1.1
 144 \        \- Detail 1.1.2
 145 \    \- TODO minor 1.2
 146 \* TODO major 2
 147 \* TODO major 3
 148 \    \* TODO minor 3.1
 149 \    \* TODO minor 3.2
 150
 151 becomes
 152
 153 TODO list:
 154 * TODO major 1
 155     - TODO minor 1.1
 156         - Detail 1.1.1
 157         - Detail 1.1.2
 158     - TODO minor 1.2
 159 * TODO major 2
 160 * TODO major 3
 161     * TODO minor 3.1
 162     * TODO minor 3.2
 163
 164 -------------------------------------------------
 165
 166 ## More information about markdown
 167
 168 can be found on
 169
 170 _http://daringfireball.net/projects/markdown/_
 171
 172 -------------------------------------------------
 173
 174 # Support for UTF-8 special characters
 175
 176 Here are some examples.
 177
 178 ae = ä, oe = ö, ue = ü, ss = ß
 179 upsilon = Ʊ, phi = ɸ
 180
 181 ▛▀▀▀▀▀▀▀▀▀▜
 182 ▌rectangle▐
 183 ▙▄▄▄▄▄▄▄▄▄▟
 184
 185
 186 -------------------------------------------------
 187
 188 # Suspend your presentation for hands-on examples
 189
 190 Use *Ctrl + z* to suspend the presentation.
 191
 192 Use *fg* to resume it.
 193
 194 -------------------------------------------------
 195
 196 # Convert your presentation to PDF
 197
 198 To publish your presentation later on, you may
 199 want to convert it to PDF.
 200
 201 This can be achieved by two additional tools:
 202
 203 \- *markdown* to convert to HTML
 204 \- *wkhtmltopdf* to convert from HTML to PDF
 205
 206 After installing them, you can simply type:
 207
 208     $ markdown sample.md | wkhtmltopdf - sample.pdf
 209
 210 -------------------------------------------------
 211
 212 ## Last words
 213
 214 I hope you like *mdp*. But be aware, that it is
 215 still in alpha status.
 216
 217 If you observe strange behavior, feel free to
 218 open an issue on GitHub:
 219
 220 _https://github.com/visit1985/mdp_
 221
 222