Skip to content

Latest commit

 

History

History
66 lines (41 loc) · 1.24 KB

README.md

File metadata and controls

66 lines (41 loc) · 1.24 KB

mdp - A command-line based markdown presentation tool.

image


How to get started:

mpd needs the ncurses headers to compile. So make sure you have them installed:

  • On Ubuntu you need libncurses5 and libncurses5-dev to be installed.

Now download and install mpd:

$ git clone https://github.com/visit1985/mdp.git
$ cd mdp
$ make
$ make install
$ mdp sample.md

How to use it:

Horizontal rulers are used as slide separator.

Supports basic markdown formating:

  • line wide formating

    • headlines
    • code
    • quotes
  • in-line formating

    • bold text
    • underlined text

Supports headers prefixed by @ symbol.

  • first two header lines are displayed as title and author in top and bottom bar

Review sample.md for more details.


Controls:

  • h, j, k, l, Cursor keys, Space, Enter, Backspace - next/previous slide
  • Home - go to first slide
  • End - go to last slide
  • 1-9 - go to slide n
  • q - exit

How to debug it:

To make a debug version of mdp, just type:

$ make DEBUG=1