Skip to content

Latest commit

 

History

316 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mdp - A command-line based markdown presentation tool.

image


How to get started

mdp needs the ncursesw headers to compile. So make sure you have them installed:

  • on Raspbian (Raspberry Pi) you need libncurses5-dev and libncursesw5-dev
  • on Fedora you need ncurses-devel and ncurses-c++-libs

Now download and install mdp:

$ git clone https://github.com/visit1985/mdp.git
$ cd mdp
$ make
$ make install
$ mdp sample.md
  • On Arch Linux, you can use the existing package.
  • on Cygwin you can use the existing package from the setup program.
  • On Debian, you can use the existing DEB package, or run apt-get install mdp.
  • On FreeBSD, you can use the port misc/mdp.
  • On MacOS, use either the Homebrew Formula by running brew install mdp or install with MacPorts with sudo port install mdp.
  • On Slackware, grab the SlackBuild here: (http://slackbuilds.org/apps/mdp/), or run sbopkg -i mdp.
  • On Ubuntu, you can use the existing DEB package, or run apt-get install mdp.

Most terminals support 256 colors only if the TERM variable is set correctly. To enjoy mdp's color fading feature:

export TERM=xterm-256color

How to use it

Horizontal rulers are used as slide separator.

Supports basic markdown formatting:

  • line wide markup

    • headlines
    • code
    • quotes
    • unordered list
  • in-line markup

    • bold text
    • underlined text
    • code

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.


Default controls

  • h, j, k, l, Arrow keys, Space, Enter, Backspace, Page Up, Page Down - next/previous slide
  • Home, g - go to first slide
  • End, G - go to last slide
  • 1-9 - go to slide n
  • r - reload input file
  • q - exit

Configuration

A config.h configuration file is available in include/, change the settings you want and recompile. Colors, keybindings and list types are configurable as of now. Note that configuring colors only works in 8 color mode.


How to debug it

To make a debug version of mdp, just type:

make DEBUG=1

Additional project resources

See the docs folder for any other supporting materials.

About

A command-line based markdown presentation tool.

Topics

Resources

Stars

5.3k stars

Watchers

68 watching

Forks

Releases

Packages

Used by

Contributors

Languages