README
======

[![Join the chat at https://gitter.im/myabc/markdownj](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/myabc/markdownj?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Build Status](https://travis-ci.org/myabc/markdownj.png?branch=master)](https://travis-ci.org/myabc/markdownj)

MarkdownJ is the pure Java port of Markdown (a text-to-html conversion tool written by John Gruber.)

### Quick Start

If you're after the core functionality provided by MarkdownJ, add `markdown-core` as a dependency:

```xml
<dependency>
  <groupId>org.markdownj</groupId>
  <artifactId>markdownj-core</artifactId>
  <version>0.4</version>
</dependency>
```

### Related Projects

* [markdownj-ant-utils][markdownj-ant-utils] – Markdown-based `FilterReader` for Ant.
* [markdownj-dingus][markdownj-dingus] – [Web Dingus using MarkdownJ][dingus] source.

### License

The project is licensed under a Revised BSD License. Refer to the accompanying
LICENSE file.

[dingus]:http://dingus.markdownj.org
[markdownj-dingus]:https://github.com/myabc/markdownj-dingus/
[markdownj-ant-utils]:https://github.com/myabc/markdownj-ant-utils/
