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 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 Code blocks are automatically detected by 4
  60 spaces at the beginning of a line.
  61
  62 Tabs are automatically expanded to 4 spaces
  63 while parsing the input.
  64
  65 \    int main(int argc, char \*argv[]) {
  66 \        printf("%s\\n", "Hello world!");
  67 \    }
  68
  69 becomes
  70
  71     int main(int argc, char *argv[]) {
  72         printf("%s\n", "Hello world!");
  73     }
  74
  75 -------------------------------------------------
  76
  77 # Supported markdown formatting's
  78
  79 Quotes are auto-detected by preceding *>*.
  80
  81 Multiple *>* are interpreted as nested quotes.
  82
  83 \> quote
  84 \>> nested quote 1
  85 \> > nested quote 2
  86
  87 becomes
  88
  89 > quote
  90 >> nested quote 1
  91 > > nested quote 2
  92
  93 -------------------------------------------------
  94
  95 # Supported markdown formatting's
  96
  97 Inline highlighting is supported as followed:
  98
  99 - *\** colors text as red
 100 - *\_* underlines text
 101
 102 \_some\_ \*highlighted\* \_\*text\*\_
 103
 104 becomes
 105
 106 _some_ *highlighted* _*text*_
 107
 108 -------------------------------------------------
 109
 110 # Supported markdown formatting's
 111
 112 Backslashes force special markdown characters
 113 like *\**, *\_*, *#* and *>* to be printed as normal
 114 characters.
 115
 116 \\\*special\\\*
 117
 118 becomes
 119
 120 \*special\*
 121
 122 -------------------------------------------------
 123
 124 ## More information about markdown
 125
 126 can be found on
 127
 128 _http://daringfireball.net/projects/markdown/_
 129
 130 -------------------------------------------------
 131
 132 # Support for UTF-8 special characters
 133
 134 Here are some examples.
 135
 136 ae = ä, oe = ö, ue = ü, ss = ß
 137 upsilon = Ʊ, phi = ɸ
 138
 139 ▛▀▀▀▀▀▀▀▀▀▜
 140 ▌rectangle▐
 141 ▙▄▄▄▄▄▄▄▄▄▟
 142
 143
 144 -------------------------------------------------
 145
 146 # Suspend your presentation for hands-on examples
 147
 148 Use *Ctrl + z* to suspend the presentation.
 149
 150 Use *fg* to resume it.
 151
 152 -------------------------------------------------
 153
 154 ## Last words
 155
 156 I hope you like *mdp*. But be aware, that it is
 157 still in alpha status.
 158
 159 If you observe strange behavior, feel free to
 160 open an issue on GitHub:
 161
 162 _https://github.com/visit1985/mdp_
 163