Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Rendering lightweight markup languages with maven

I would like to render project documentation in html from a lighweight markup language like markdown or textile. What's easiest way to do this?

like image 942
Thomas Jung Avatar asked Feb 18 '11 08:02

Thomas Jung


2 Answers

You can also use other lightweight markup languages with the maven-site-plugin. This is done through doxia (maven's content generation framework). There is a doxia module for markdown, for example:

http://code.google.com/p/doxia-module-markdown/wiki/Usage

like image 160
Andrey Taranov Avatar answered Oct 15 '22 02:10

Andrey Taranov


The maven site plugin is able to render the APT format ("Almost Plain Text") to build html for the project (documentation) site.

@See:

http://maven.apache.org/plugins/maven-site-plugin/examples/creating-content.html

http://maven.apache.org/doxia/references/apt-format.html

like image 22
Ralph Avatar answered Oct 15 '22 02:10

Ralph