From: Michael Göhler <somebody.here@gmx.de>
Date: Thu, 18 Sep 2014 22:21:42 +0000 (+0200)
Subject: extend sample.md so it looks more like a documentation
X-Git-Url: https://git.danieliu.xyz/?a=commitdiff_plain;h=785ae9e96355a7d14e9ab37e4ef9662e5f19d8e0;p=smdp.git

extend sample.md so it looks more like a documentation
---

diff --git a/sample.md b/sample.md
index 53afc65..2a7b934 100644
--- a/sample.md
+++ b/sample.md
@@ -1,26 +1,121 @@
-%title: Sample Presentation
+%title: mdp - Sample Presentation
 %author: Michael Göhler
-%date: 2014-09-14
+%date: 2014-09-18
 
 mdp
 ===
 
-A command-line based presentation tool.
+A command-line based markdown presentation tool.
 
---------------------------------------------
+-------------------------------------------------
 
-Here are some formating tests:
+# Supported markdown formatting's
 
-These are 3 stars: \*\*\*
-And two backslashes: \\\\
+First-level headers can be prefixed by single *#*
+or underlined by *===*.
 
-This text is _underlined_ and *highlighted*.
+\# first-level
 
-These are some _incomplete *tags.
+becomes
 
-********************************************
+# first-level
 
-# UTF-8 support
+-------------------------------------------------
+
+# Supported markdown formatting's
+
+Second-level headers can be prefixed by *##* or
+underlined by *---*.
+
+second-level
+\------------
+
+becomes
+
+second-level
+------------
+
+
+-------------------------------------------------
+
+# Supported markdown formatting's
+
+Code blocks are automatically detected by 4
+spaces at the beginning of a line.
+
+Tabs are automatically expanded to 4 spaces
+while parsing the input.
+
+\    int main(int argc, char \*argv[]) {
+\        printf("%s\\n", "Hello world!");
+\    }
+
+becomes
+
+    int main(int argc, char *argv[]) {
+        printf("%s\n", "Hello world!");
+    }
+
+-------------------------------------------------
+
+# Supported markdown formatting's
+
+Quotes are auto-detected by preceding *>*.
+
+Multiple *>* are interpreted as nested quotes.
+
+\> quote
+\>> nested quote 1
+\> > nested quote 2
+
+becomes
+
+> quote
+>> nested quote 1
+> > nested quote 2
+
+-------------------------------------------------
+
+# Supported markdown formatting's
+
+Inline highlighting is supported as followed:
+
+- *\** colors text as red
+- *\_* underlines text
+
+\_some\_ \*highlighted\* \_\*text\*\_
+
+becomes
+
+_some_ *highlighted* _*text*_
+
+-------------------------------------------------
+
+# Supported markdown formatting's
+
+Backslashes force special markdown characters
+like *\**, *\_*, *#* and *>* to be printed as normal
+characters.
+
+\\\*special\\\*
+
+becomes
+
+\*special\*
+
+-------------------------------------------------
+
+## More information about markdown
+
+can be found on
+
+_http://daringfireball.net/projects/markdown/_
+
+-------------------------------------------------
+
+# Support for UTF-8 special characters
+
+Here are some examples.
 
 ae = ä, oe = ö, ue = ü, ss = ß
 upsilon = Ʊ, phi = ɸ
@@ -29,27 +124,24 @@ upsilon = Ʊ, phi = ɸ
 ▌rectangle▐
 ▙▄▄▄▄▄▄▄▄▄▟
 
-* * *
 
-## Code examples
+-------------------------------------------------
 
-    public static void main() {
-    
-        printf("%s\n", "hello");
-    }
+# Suspend your presentation for hands-on examples
 
-Now with *different* indentation.
+Use *Ctrl + z* to suspend the presentation.
 
-	function expand_tab {
-        printf("%s\n", "hello");
-    }
+Use *fg* to resume it.
+
+-------------------------------------------------
+
+## Last words
 
-***
+I hope you like *mdp*. But be aware, that it is
+still in alpha status.
 
-This is the end.
-----------------
+If you observe strange behavior, feel free to
+open an issue on GitHub:
 
->
-> My only friend, the end.
->
+_https://github.com/visit1985/mdp_