Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
4 contributors

Users who have contributed to this file

@visit1985 @namhyung @mnalt @anders-dc
326 lines (206 sloc) 6.05 KB

%title: mdp - Sample Presentation %author: visit1985 %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 <-

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 ===.

# first-level

becomes

first-level


-> # Supported markdown formatting <-

Second-level headers can be prefixed by ## or underlined by ---.

second-level ------------

becomes

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 <-

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 <-

You can also use pandoc'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

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 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 >.

Multiple > are interpreted as nested quotes.

> quote >> nested quote 1 > > nested quote 2

becomes

quote

nested quote 1 nested quote 2


-> # Supported markdown formatting <-

Inline highlighting is supported as followed:

- * colors text as red - _ underlines text

_some_ *highlighted* _*text*_

becomes

some highlighted text


-> # Supported markdown formatting <-

Backslashes force special markdown characters like *, _, # and > to be printed as normal characters.

\*special\*

becomes

*special*


-> # 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

  • 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


-> ## More information about markdown <-

can be found in the markdown documentation.


-> # Support for UTF-8 special characters <-

Here are some examples.

ae = ä, oe = ö, ue = ü, ss = ß upsilon = Ʊ, phi = ɸ

▛▀▀▀▀▀▀▀▀▀▜ ▌rectangle▐ ▙▄▄▄▄▄▄▄▄▄▟


-> # Suspend your presentation for hands-on examples <-

Use Ctrl + z to suspend the presentation.

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.

If you observe strange behavior, feel free to open an issue on GitHub.

You can’t perform that action at this time.