X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=sample.md;h=88bcd345bb57fe9bdc89231f8a9e86b3d098fa98;hb=4349c96187dcf97eedcbe7297379df42f705757e;hp=a679ba21bf19d9214a80ec2fc4142c8334d134e5;hpb=5f369c826ac0ca4989892b3691f66d0ac73679f3;p=smdp.git
diff --git a/sample.md b/sample.md
index a679ba2..88bcd34 100644
--- a/sample.md
+++ b/sample.md
@@ -1,22 +1,36 @@
%title: mdp - Sample Presentation
%author: visit1985
-%date: 2014-09-22
+%date: 2016-02-07
-> mdp <-
=========
-> 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 *---*.
@@ -66,13 +80,13 @@ C program starts with `main()`.
-------------------------------------------------
--> # Supported markdown formatting's <-
+-> # Supported markdown formatting <-
-Code blocks are automatically detected by 4
-spaces at the beginning of a line.
+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.
+Tabs are automatically expanded to 4 spaces while
+parsing the input.
\ int main(int argc, char \*argv[]) {
\ printf("%s\\n", "Hello world!");
@@ -86,7 +100,56 @@ becomes
-------------------------------------------------
--> # Supported markdown formatting's <-
+-> # Supported markdown formatting <-
+
+You can also use [pandoc](https://pandoc.org/MANUAL.html#fenced-code-blocks)'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 <-
+
+You can also use [github](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) flavored markdown's
+code block. Use at least three backticks to open
+and at least as many or more backticks for closing.
+
+\```
+\int main(int argc, char \*argv[]) {
+\ printf("%s\\n", "Hello world!");
+\}
+\```
+
+becomes
+
+```
+int main(int argc, char *argv[]) {
+ printf("%s\n", "Hello world!");
+}
+```
+
+Language hint will be ignored
+
+-------------------------------------------------
+
+-> # Supported markdown formatting <-
Quotes are auto-detected by preceding *>*.
@@ -104,7 +167,7 @@ becomes
-------------------------------------------------
--> # Supported markdown formatting's <-
+-> # Supported markdown formatting <-
Inline highlighting is supported as followed:
@@ -119,11 +182,11 @@ _some_ *highlighted* _*text*_
-------------------------------------------------
--> # Supported markdown formatting's <-
+-> # Supported markdown formatting <-
Backslashes force special markdown characters
-like *\**, *\_*, *#* and *>* to be printed as normal
-characters.
+like *\**, *\_*, *#* and *>* to be printed as
+normal characters.
\\\*special\\\*
@@ -133,7 +196,7 @@ becomes
-------------------------------------------------
--> # Supported markdown formatting's <-
+-> # Supported markdown formatting <-
Leading *\** or *-* indicate lists.
@@ -155,7 +218,32 @@ list
-------------------------------------------------
--> # Supported markdown formatting's <-
+-> # 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.
@@ -173,11 +261,21 @@ becomes
-------------------------------------------------
--> ## More information about markdown <-
+-> # Supported markdown formatting <-
-can be found on
+URL in pandoc style are supported:
-_http://daringfireball.net/projects/markdown/_
+\[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/).
-------------------------------------------------
@@ -221,12 +319,7 @@ After installing them, you can simply type:
-> ## Last words <-
-I hope you like *mdp*. But be aware, that it is
-still in alpha status.
+I hope you like *mdp*.
If you observe strange behavior, feel free to
-open an issue on GitHub:
-
-_https://github.com/visit1985/mdp_
-
-
+open an issue on [GitHub](https://github.com/visit1985/mdp).