X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=sample.md;h=6e70ab8f984cbf1c7619de4ac3923cfe4b6498d9;hb=43d2fc7060b16923ffebf75230e79081206c4b74;hp=2a7b9347f0536b4338a9fe2b8eb49b2768b97a1e;hpb=2c77b5e6e665dcce85cc22d7673573c46137593d;p=smdp.git
diff --git a/sample.md b/sample.md
index 2a7b934..6e70ab8 100644
--- a/sample.md
+++ b/sample.md
@@ -1,15 +1,45 @@
%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.
+
+\* \* \*
+\---
+\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
+\- - -
+
+-------------------------------------------------
+
+-> # Supported markdown formatting <-
First-level headers can be prefixed by single *#*
or underlined by *===*.
@@ -22,7 +52,7 @@ becomes
-------------------------------------------------
-# Supported markdown formatting's
+-> # Supported markdown formatting <-
Second-level headers can be prefixed by *##* or
underlined by *---*.
@@ -38,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.
@@ -58,7 +100,31 @@ becomes
-------------------------------------------------
-# Supported markdown formatting's
+-> # Supported markdown formatting <-
+
+You can also use [pandoc](http://pandoc.org/demo/example9/pandocs-markdown.html)'s fenced code block extension.
+Use at least three ~ chars to open and at least as many or
+more ~ for closing.
+
+\~~~ {.numberLines}
+\int main(int argc, char \*argv[]) {
+\ printf("%s\\n", "Hello world!");
+\}
+\~~~~~~~~~~~~~~~~~~
+
+becomes
+
+~~~ {.numberLines}
+int main(int argc, char \*argv[]) {
+ printf("%s\\n", "Hello world!");
+}
+~~~~~~~~~~~~~~~~~~
+
+Pandoc attributes (like ".numberlines" etc.) will be ignored
+
+-------------------------------------------------
+
+-> # Supported markdown formatting <-
Quotes are auto-detected by preceding *>*.
@@ -76,12 +142,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\*\_
@@ -91,7 +157,7 @@ _some_ *highlighted* _*text*_
-------------------------------------------------
-# Supported markdown formatting's
+-> # Supported markdown formatting <-
Backslashes force special markdown characters
like *\**, *\_*, *#* and *>* to be printed as normal
@@ -105,15 +171,90 @@ becomes
-------------------------------------------------
-## More information about markdown
+-> # Supported markdown formatting <-
+
+Leading *\** or *-* indicate lists.
+
+list
+\* major
+\ - minor
+\ - \*important\*
+\ detail
+\ - minor
-can be found on
+becomes
-_http://daringfireball.net/projects/markdown/_
+list
+* major
+ - minor
+ - *important*
+ detail
+ - minor
-------------------------------------------------
-# Support for UTF-8 special characters
+-> # Supported markdown formatting <-
+
+A single *\
* or *^* in a line indicates mdp
+to stop the output on that position.
+
+This can be used to show bullet points
+line by line.
+
+*\
* is also not displayed in HTML converted
+output.
+
+Agenda
+
+* major
+
+ * minor
+
+* 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/)
+
+-------------------------------------------------
+
+-> ## More information about markdown <-
+
+can be found in the [markdown documentation](http://daringfireball.net/projects/markdown/).
+
+-------------------------------------------------
+
+-> # Support for UTF-8 special characters <-
Here are some examples.
@@ -127,7 +268,7 @@ upsilon = Ʊ, phi = ɸ
-------------------------------------------------
-# Suspend your presentation for hands-on examples
+-> # Suspend your presentation for hands-on examples <-
Use *Ctrl + z* to suspend the presentation.
@@ -135,13 +276,25 @@ 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:
+
+ $ markdown sample.md | wkhtmltopdf - sample.pdf
-_https://github.com/visit1985/mdp_
+-------------------------------------------------
+
+-> ## Last words <-
+I hope you like *mdp*.
+
+If you observe strange behavior, feel free to
+open an issue on [GitHub](https://github.com/visit1985/mdp).