X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=sample.md;h=3e3d62ebbc09a11ab295ba4c7ad432851fb06ac7;hb=9adad15f5201cd5e78dcde688ceb6d7b56e0fffb;hp=fd3a8d8ff81426937befc2d65b797c958df10c88;hpb=2854a2e2ba7bd3c38bb4ebf4213b132a6e2fd882;p=smdp.git

diff --git a/sample.md b/sample.md
index fd3a8d8..3e3d62e 100644
--- a/sample.md
+++ b/sample.md
@@ -1,22 +1,36 @@
 %title: mdp - Sample Presentation
-%author: Michael Göhler
-%date: 2014-09-18
+%author: visit1985
+%date: 2014-09-22
 
-mdp
-===
+-> mdp <-
+=========
 
-A command-line based markdown presentation tool.
+-> A command-line based markdown presentation tool. <-
+
+_Basic controls:_
+
+next slide      *Enter*, *Space*, *Page Down*, *j*, *l*,
+                *Down Arrow*, *Right Arrow*
+
+previous slide  *Backspace*, *Page Up*, *h*, *k*,
+                *Up Arrow*, *Left Arrow*
+
+quit            *q*
+reload          *r*
+slide N         *1..9*
+first slide     *Home*, *g*
+last slide      *End*, *G*
 
 -------------------------------------------------
 
-# Supported markdown formatting's
+-> # Supported markdown formatting <-
 
 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
+Each of these represents the start of a new slide.
 
 \* \* \*
 \---
@@ -25,7 +39,7 @@ Each of these represents the start of a new slide
 
 -------------------------------------------------
 
-# Supported markdown formatting's
+-> # Supported markdown formatting <-
 
 First-level headers can be prefixed by single *#*
 or underlined by *===*.
@@ -38,7 +52,7 @@ becomes
 
 -------------------------------------------------
 
-# Supported markdown formatting's
+-> # Supported markdown formatting <-
 
 Second-level headers can be prefixed by *##* or
 underlined by *---*.
@@ -54,7 +68,19 @@ second-level
 
 -------------------------------------------------
 
-# Supported markdown formatting's
+-> # Supported markdown formatting's <-
+
+Inline codes are surrounded with backticks.
+
+C program starts with \`main()\`.
+
+becomes
+
+C program starts with `main()`.
+
+-------------------------------------------------
+
+-> # Supported markdown formatting <-
 
 Code blocks are automatically detected by 4
 spaces at the beginning of a line.
@@ -74,7 +100,7 @@ becomes
 
 -------------------------------------------------
 
-# Supported markdown formatting's
+-> # Supported markdown formatting <-
 
 Quotes are auto-detected by preceding *>*.
 
@@ -92,12 +118,12 @@ becomes
 
 -------------------------------------------------
 
-# Supported markdown formatting's
+-> # Supported markdown formatting <-
 
 Inline highlighting is supported as followed:
 
-- *\** colors text as red
-- *\_* underlines text
+\- *\** colors text as red
+\- *\_* underlines text
 
 \_some\_ \*highlighted\* \_\*text\*\_
 
@@ -107,7 +133,7 @@ _some_ *highlighted* _*text*_
 
 -------------------------------------------------
 
-# Supported markdown formatting's
+-> # Supported markdown formatting <-
 
 Backslashes force special markdown characters
 like *\**, *\_*, *#* and *>* to be printed as normal
@@ -121,15 +147,90 @@ becomes
 
 -------------------------------------------------
 
-## More information about markdown
+-> # Supported markdown formatting <-
+
+Leading *\** or *-* indicate lists.
+
+list
+\* major
+\    - minor
+\        - \*important\*
+\          detail
+\    - minor
+
+becomes
+
+list
+* major
+    - minor
+        - *important*
+          detail
+    - minor
+
+-------------------------------------------------
+
+-> # Supported markdown formatting <-
+
+A single *\<br\>* or *^* in a line indicates mdp
+to stop the output on that position.
+
+This can be used to show bullet points
+line by line.
+
+*\<br\>* is also not displayed in HTML converted
+output.
+
+Agenda
+<br>
+* major
+<br>
+    * minor
+<br>
+* major
+  ^
+    * minor
+      ^
+        * detail
+
+-------------------------------------------------
+
+-> # Supported markdown formatting <-
+
+Leading *->* indicates centering.
+
+\-> # test <-
+\-> ## test <-
+\-> test
+\-> \_\*test\*\_ <-
+
+becomes
+
+-> # test <-
+-> ## test <-
+-> test
+-> _*test*_ <-
+
+-------------------------------------------------
+
+-> # Supported markdown formatting <-
+
+URL in pandoc style are supported:
+
+\[Google](http://www.google.com/)
+
+becomes
+
+[Google](http://www.google.com/)
+
+-------------------------------------------------
 
-can be found on
+-> ## More information about markdown <-
 
-_http://daringfireball.net/projects/markdown/_
+can be found in the [markdown documentation](http://daringfireball.net/projects/markdown/).
 
 -------------------------------------------------
 
-# Support for UTF-8 special characters
+-> # Support for UTF-8 special characters <-
 
 Here are some examples.
 
@@ -143,7 +244,7 @@ upsilon = Ʊ, phi = ɸ
 
 -------------------------------------------------
 
-# Suspend your presentation for hands-on examples
+-> # Suspend your presentation for hands-on examples <-
 
 Use *Ctrl + z* to suspend the presentation.
 
@@ -151,13 +252,26 @@ Use *fg* to resume it.
 
 -------------------------------------------------
 
-## Last words
+-> # Convert your presentation to PDF <-
 
-I hope you like *mdp*. But be aware, that it is
-still in alpha status.
+To publish your presentation later on, you may
+want to convert it to PDF.
 
-If you observe strange behavior, feel free to
-open an issue on GitHub:
+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:
 
-_https://github.com/visit1985/mdp_
+    $ markdown sample.md | wkhtmltopdf - sample.pdf
 
+-------------------------------------------------
+
+-> ## Last words <-
+
+I hope you like *mdp*. But be aware that it is
+still in alpha status.
+
+If you observe strange behavior, feel free to
+open an issue on [GitHub](https://github.com/visit1985/mdp).