Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sangupta/nutz

Markdown processor for JVM. Hand-coded parser generates AST and allows for easy addition of extensions.
https://github.com/sangupta/nutz

Last synced: 4 days ago
JSON representation

Markdown processor for JVM. Hand-coded parser generates AST and allows for easy addition of extensions.

Awesome Lists containing this project

README 

        
nutz

====



`nutz` is yet another Markdown processor for the JVM. It is a handcoded parser that generates an Abstract Syntax Tree before emitting the final HTML code. It may make use of Pepmint to support code highlighting in mentioned language.



The need for `nutz` arises from the fact that none of the available Markdown processors for JVM have the following characterstics:



* Generates an AST of the parsed data

* Easily extendable and customizable

* Is not regex-based

* Is fast enough

* Is as low-weight as possible



`pegdown` uses PEG grammar which is difficult to extend and passes 21 of 23 Markdown tests. `Actuarius` and `Knockoff` are written in Scala and use regular expressions for parsing. `txtmark` passes only 20 of 23 Markdown tests



Markdown tests are benchmark tests as laid by [Daring Fireball](http://daringfireball.net/projects/markdown). 



Links to alternative implementations are provided below.



Features

--------



**Development Version**



* Support for standard Markdown syntax per Daring Fireball suite

* Suport for PHP fenced code blocks

* Support for Github-Flavored fenced code blocks

* All 23 tests pass



RoadMap

-------



* Abbreviations

* SmartyPants

* Definition lists

* Wiki-style links

* URL auto-linking

* Support for text-transformers

* Support for turning on/off extensions

* Support for syntax-highlighting techniques in code blocks (using Syntax-Highlighter or [Pepmint](https://www.sangupta.com/sangupta/pepmint)



Downloads

---------



The working development version can be downloaded from:



```xml



    com.sangupta

    nutz

    0.5.0



```



Continuous Integration

----------------------

The **library** is continuously integrated and unit tested using the *Travis CI system*.



Current status of branch `MASTER`: [![Build Status](https://secure.travis-ci.org/sangupta/nutz.png?branch=master)](http://travis-ci.org/sangupta/nutz)



The library is tested against



* Oracle JDK 7

* Oracle JDK 6

* Open JDK 7

* Open JDK 6



Alternatives

------------



`nutz` is not the first or the only-one around in the arena. Other Markdown processors available for JVM are:



* [Pegdown](http://pegdown.org)

* [Txtmark](https://github.com/rjeschke/txtmark)

* [Actuarius](https://github.com/chenkelmann/actuarius)

* [Knockoff](http://tristanjuricek.com/knockoff/)



Versioning

----------



For transparency and insight into our release cycle, and for striving to maintain backward compatibility, 

`nutz` will be maintained under the Semantic Versioning guidelines as much as possible.



Releases will be numbered with the follow format:



`..`



And constructed with the following guidelines:



* Breaking backward compatibility bumps the major

* New additions without breaking backward compatibility bumps the minor

* Bug fixes and misc changes bump the patch



For more information on SemVer, please visit http://semver.org/.



License

-------

	

Copyright (c) 2012, Sandeep Gupta



The project uses various other libraries that are subject to their

own license terms. See the distribution libraries or the project

documentation for more details.



The entire source is licensed under the Apache License, Version 2.0 

(the "License"); you may not use this work except in compliance with

the LICENSE. You may obtain a copy of the License at



	http://www.apache.org/licenses/LICENSE-2.0



Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.