Skip to content

basejump/markdown-plus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Markdown Plus

Markdown Plus is a Groovy port of Markdown. Markdown Plus will process your md documents and give you a pretty html or pdf. Not that you need a pretty html or pdf for most things since markdown is meant to be just as readable as a text document

Introduction

Markdown Plus is a Groovy port of the Markdown program written by John Gruber and the syntax of course 100% supports core Markdown.

"The Markdown syntax allows you to write text naturally and format it without using HTML tags. More importantly: in Markdown format, your text stays enjoyable to read for a human being, and this is true enough that it makes a Markdown document publishable as-is, as plain text. If you are using text-formatted email, you already know some part of the syntax." - PHP Markdown

Markdown Plus is 3 things:

  1. a plain text syntax for any type of meassge post, documentation, readme, recipes, poems, etc...
  2. a tool that converts the plain text with some basic convetions of formating, to HTML or pdf for publishing on the web or printing (but printing is not very green now is it?)
  3. extended syntax to the Markdown heavily based on the the Perl derivitive called MultiMarkdown and the PHP derivative PHP Markdown Extra

Installation and Running

Markdown Plus requires java 1.5 or later.

Add the directory where you unzipped or checked-out Markdown Plus to your PATH. This would be the root directory where the bash mdp script or bat is located.

then type

mdp yourfile.md

and out will come the html and pdf for your Markdown text

Syntax

See the excellent MultiMarkdown Syntax for what Markdown Plus supports. And of course check out thecore syntax here Markdown

What we "mostly" support from MultiMarkdown

What we don't yet support from MultiMarkdown and PHP Extra

  • bibliography stuff
  • the xmlt translations he does. although you can always download his. Most any syntax that works with Markdown Plus will work with his.
  • footnotes

TODO

-table caption -CSS

About

A Groovy parser for markdown and some extensions based on php-markdown extra and MultiMarkdown

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published