Fork me on GitHub

markdownj

A Java port of Markdown, the text-to-html conversion tool

MarkdownJ Quick Start

This quick start assumes a basic familiarity with Java.

MarkdownJ as a standalone application

MarkdownJ can be used from the command line as a simple text2html conversion utility. The textfile to be converted is read in on stdin and the resulting html is output to stdout.
  1. Make sure your classpath includes markdownj-0.1.0.jar.
  2. Launch MarkdownJ with "java com.petebevin.markdown.MarkdownProcessor < textfile > htmlfile".

MarkdownJ as a library in another Java application

The primary use of MarkdownJ is as a class library to be invoked in your Java application.
  1. Make sure your application classpath includes markdownj-0.1.0.jar.
  2. Use the following sample code to invoke MarkdownJ " m = new MarkdownProcessor(); String html = m.markdown("This is a *simple* test.");".

Bugs, Suggestions, Etc.

If you find any bugs or have any suggestions for improvements, please post to the MarkdownJ Google Group.