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 list
 141 \* major
 142 \    - minor
 143 \        - \*important\*
 144 \          detail
 145 \    - minor
 146
 147 becomes
 148
 149 list
 150 * major
 151     - minor
 152         - *important*
 153           detail
 154     - minor
 155
 156 -------------------------------------------------
 157
 158 -> # Supported markdown formatting's <-
 159
 160 Leading *->* indicates centering.
 161
 162 \-> # test <-
 163 \-> ## test <-
 164 \-> test
 165 \-> \_\*test\*\_ <-
 166
 167 becomes
 168
 169 -> # test <-
 170 -> ## test <-
 171 -> test
 172 -> _*test*_ <-
 173
 174 -------------------------------------------------
 175
 176 -> # Supported markdown formatting's <-
 177
 178 URL in John MacFarlane's Pandoc style are supported :
 179
 180 \[GitHub repository for mdp](https://github.com/visit1985/mdp)
 181 \[Google](google.com)
 182
 183 [GitHub repository for mdp](https://github.com/visit1985/mdp)
 184 [Google](google.com)
 185
 186 -------------------------------------------------
 187
 188 -> ## More information about markdown <-
 189
 190 can be found on
 191
 192 _http://daringfireball.net/projects/markdown/_
 193
 194 -------------------------------------------------
 195
 196 -> # Support for UTF-8 special characters <-
 197
 198 Here are some examples.
 199
 200 ae = ä, oe = ö, ue = ü, ss = ß
 201 upsilon = Ʊ, phi = ɸ
 202
 203 ▛▀▀▀▀▀▀▀▀▀▜
 204 ▌rectangle▐
 205 ▙▄▄▄▄▄▄▄▄▄▟
 206
 207
 208 -------------------------------------------------
 209
 210 -> # Suspend your presentation for hands-on examples <-
 211
 212 Use *Ctrl + z* to suspend the presentation.
 213
 214 Use *fg* to resume it.
 215
 216 -------------------------------------------------
 217
 218 -> # Convert your presentation to PDF <-
 219
 220 To publish your presentation later on, you may
 221 want to convert it to PDF.
 222
 223 This can be achieved by two additional tools:
 224
 225 \- *markdown* to convert to HTML
 226 \- *wkhtmltopdf* to convert from HTML to PDF
 227
 228 After installing them, you can simply type:
 229
 230     $ markdown sample.md | wkhtmltopdf - sample.pdf
 231
 232 -------------------------------------------------
 233
 234 -> ## Last words <-
 235
 236 I hope you like *mdp*. But be aware, that it is
 237 still in alpha status.
 238
 239 If you observe strange behavior, feel free to
 240 open an issue on GitHub:
 241
 242 _https://github.com/visit1985/mdp_
 243
 244