Skip to content

Very configurable Markdown processor supporting the CommonMark spec and many extensions.

License

Notifications You must be signed in to change notification settings

mkende/pmarkdown

Repository files navigation

pmarkdown

Very configurable Markdown processor supporting the CommonMark spec and many extensions.

Main features

This software supports the entire CommonMark spec syntax, as well as all GitHub Flavored Markdown (gfm) extensions some more custom extensions. It also has compatibility with the original Markdown syntax.

See the Syntax page for a full description of the default syntax supported by pmarkdown. You can also try it out online or compare it to other implementations by using Babelmark.

This program is based on the Markdown::Perl library that can be used in standalone Perl programs.

Usage

Using pmarkdown is as simple as running the following command:

pmarkdown < input.md > output.html

You can read about all the command line options in the pmarkdown documentation.

Installation

Pre-compiled binaries for Windows and Linux

You can download portable versions of pmarkdown for Windows and Linux on the releases page.

Installation from the Perl package manager

To install pmarkdown you need Perl (which is already installed on most Linux distributions) and you need the cpanm Perl package manager. In addition, the perl-doc program is optional but will improve the display of the program documentation. You can usually get them with one of these commands:

# On Debian, Ubuntu, Mint, etc.
sudo apt-get install perl cpanminus perl-doc

# On Red Hat, Fedora, CentOS, etc.
sudo yum install perl perl-App-cpanminus perl-doc

Then run the following to install pmarkdown:

sudo cpanm App::pmarkdown -n -L /usr/local --man-pages --install-args 'DESTINSTALLBIN=/usr/local/bin'

Installation from the Git sources

To install pmarkdown you need Perl (which is already installed on most Linux distributions) and you need the cpanm Perl package manager. In addition, the perl-doc program is optional but will improve the display of the program documentation. You can usually get them with one of these commands:

# On Debian, Ubuntu, Mint, etc.
sudo apt-get install perl cpanminus perl-doc

# On Red Hat, Fedora, CentOS, etc.
sudo yum install perl perl-App-cpanminus perl-doc

Then run the following command to install pmarkdown (note that you do not need to initialize the git submodules):

git clone https://github.com/mkende/pmarkdown.git
cd pmarkdown
cpanm --notest --with-configure --installdeps .
perl Makefile.PL
make
sudo make install

Note that, with this installation method, you might need to reinstall the program each time your system Perl is updated. So the methods above are recommended.

About

Very configurable Markdown processor supporting the CommonMark spec and many extensions.

Topics

Resources

License

Stars

Watchers

Forks

Languages