Add list sample.

[smdp.git] / sample.md

diff --git a/sample.md b/sample.md
index 2a7b934..56d4ea2 100644 (file)
--- a/sample.md
+++ b/sample.md
@@ -1,6 +1,6 @@
 %title: mdp - Sample Presentation
-%author: Michael Göhler
-%date: 2014-09-18
+%author: visit1985
+%date: 2014-09-22
 
 mdp
 ===
@@ -11,6 +11,22 @@ A command-line based markdown presentation tool.
 
 # Supported markdown formatting's
 
+The input file is split into multiple slides by
+horizontal rules (hr). A hr consisting of at
+least 3 *\** or *-*. It can also contain spaces but
+no other characters.
+
+Each of these represents the start of a new slide
+
+\* \* \*
+\---
+\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
+\- - -
+
+-------------------------------------------------
+
+# Supported markdown formatting's
+
 First-level headers can be prefixed by single *#*
 or underlined by *===*.
 
@@ -36,6 +52,18 @@ second-level
 ------------
 
 
+-------------------------------------------------
+
+# Supported markdown formatting's
+
+Inline codes are surrounded with backticks.
+
+C program starts with \`main()\`.
+
+becomes
+
+C program starts with `main()`.
+
 -------------------------------------------------
 
 # Supported markdown formatting's
@@ -80,8 +108,8 @@ becomes
 
 Inline highlighting is supported as followed:
 
-- *\** colors text as red
-- *\_* underlines text
+\- *\** colors text as red
+\- *\_* underlines text
 
 \_some\_ \*highlighted\* \_\*text\*\_
 
@@ -105,6 +133,32 @@ becomes
 
 -------------------------------------------------
 
+# Supported markdown formatting's
+
+The leading stars or minuses make list.
+
+TODO list:
+\* TODO major 1
+\    \- TODO minor 1.1
+\    \- TODO minor 1.2
+\* TODO major 2
+\* TODO major 3
+\    \* TODO minor 3.1
+\    \* TODO minor 3.2
+
+becomes
+
+TODO list:
+* TODO major 1
+    - TODO minor 1.1
+    - TODO minor 1.2
+* TODO major 2
+* TODO major 3
+    * TODO minor 3.1
+    * TODO minor 3.2
+
+-------------------------------------------------
+
 ## More information about markdown
 
 can be found on
@@ -135,6 +189,22 @@ Use *fg* to resume it.
 
 -------------------------------------------------
 
+# Convert your presentation to PDF
+
+To publish your presentation later on, you may
+want to convert it to PDF.
+
+This can be achieved by two additional tools:
+
+\- *markdown* to convert to HTML
+\- *wkhtmltopdf* to convert from HTML to PDF
+
+After installing them, you can simply type:
+
+    $ markdown sample.md | wkhtmltopdf - sample.pdf
+
+-------------------------------------------------
+
 ## Last words
 
 I hope you like *mdp*. But be aware, that it is
@@ -145,3 +215,4 @@ open an issue on GitHub:
 
 _https://github.com/visit1985/mdp_
 
+