Parm

Parm is an open source and free web-based and command-line software that has been designed from the ground up to help you easily and quickly convert your favorite Markdown files to HTML (HyperText Markup Language) documents, featuring support for Bootstrap CSS and Semantic-UI themes.

Uses the Par module

The software makes use of the Par module created by the same author, and has been engineered to support TOC (Table of Contents) index files, custom CSS styles and templates, as well as extended markdown syntax, such as the one used on the Github website.

Getting started with Parm

Parm is distributed only as a tarball, which includes the source code of the project, so you will have to manually install it on your GNU/Linux distribution using the “pip install parm” command in a terminal emulator (without quotes).

Then, you will be able to write your markdown documents in the /project/docs directory. Detailed installation and usage instructions are provided on the project’s web page, at http://limodou.github.io/parm/README.html, as well as a demo of how the application looks and works at http://limodou.github.io/parm or http://limodou.github.io/uliweb-doc.

Additionally, the GitHub page of the project will teach you how to initialize the environment, write TOC (Table of Contents), convert Markdown syntax to HTML, convert reStructuredText to Markdown, add disqus support, customize its look by changing the template’s layout, change the introductory information on the index, exclude files, and host your documents in Github pages.

Under the hood and availability

The software is written entirely in the Python programming language, which means that it is portable on various operating systems that support Python. It has been successfully tested with several GNU/Linux distributions, running well on both 32-bit and 64-bit instruction set architectures.

What is new in this release:

• Refactor with _compat.py

What is new in version 1.1:

• This version adds an include syntax so you can include source code in the current document, adds a test_parm.py test file, and fixes the customized `prettify.css` bug in the semantic theme.

What is new in version 1.0:

• 'setup.py' was changed, and a 'par' package requirement was added.
• Google Search support was added. You can configure it via the init command.
• A bug in 'rst2md' with parsing '.. contents::' was fixed.
• The command parameters for 'rst2md' and 'make' were changed.

Requirements:

• Python
• Par