My favorites | Sign in
Project Home Downloads Wiki Issues Source
Search
for
Usage  
How to use this module
Featured, Phase-Deploy
Updated May 21 (5 days ago) by regis.de...@gmail.com

Introduction

Doxia is a content generation framework. A Doxia module is an implementation of a given markup language like APT, Docbook, or Markdown.

Markdown is an elegant markup language.

This doxia modules parses files in the Markdown syntax.

Use for Maven site

You can use Markdown instead of ATP in the mvn site goal.

Write Markdown files

Write the Markdown files in src/site/markdown

Edit you POM

Edit your POM to reference the module in the maven-site-plugin

	<build>
		<plugins>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-site-plugin</artifactId>
				<dependencies>
					<dependency>
						<groupId>org.apache.maven.doxia</groupId>
						<artifactId>doxia-module-markdown</artifactId>
						<version>1.3</version>
					</dependency>
				</dependencies>
				<configuration>
					<inputEncoding>UTF-8</inputEncoding>
					<outputEncoding>UTF-8</outputEncoding>
				</configuration>
			</plugin>
<!-- other  plugins ... ->
		</plugins>
<!-- other build instructions -->
	</build>

Use in Java code

You can also use the Doxia framework in your Java program.

Comment by lcorneliussen@gmail.com, Jan 6, 2012

Is it possible to run markdown for maven plugin documentation?


Sign in to add a comment
Powered by Google Project Hosting