Markdown Maven Plugin

This project aims to provide a maven plugin that generate documentation based on Markdown syntax.

License	The Apache Software License, Version 2.0
Categories	Maven Build Tools
GroupId	org.javabits.maven.md
ArtifactId	md-maven-pluging
Last Version	1.0.0.M3
Release Date	Mar 3, 2014
Type	maven-plugin
Description	Markdown Maven Plugin This project aims to provide a maven plugin that generate documentation based on Markdown syntax.
Project URL	https://github.com/javabits/md-maven-plugin
Source Code Management	https://github.com/javabits/md-maven-plugin

Download md-maven-pluging

Filename	Size
md-maven-pluging-1.0.0.M3.pom
md-maven-pluging-1.0.0.M3.jar	424 KB
md-maven-pluging-1.0.0.M3-sources.jar	407 KB
md-maven-pluging-1.0.0.M3-javadoc.jar	53 KB

How to add to project

Apache Maven

<plugin>
    <groupId>org.javabits.maven.md</groupId>
    <artifactId>md-maven-pluging</artifactId>
    <version>1.0.0.M3</version>
</plugin>

Dependencies

compile (7)

Group / Artifact	Type	Version
com.google.guava : guava	jar	14.0.1
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.2
org.apache.maven : maven-project	jar	2.2.1
org.pegdown : pegdown	jar	1.4.1
org.apache.maven : maven-plugin-api	jar	3.0.5
org.codehaus.plexus : plexus-utils	jar	3.0.10
org.codehaus.plexus : plexus-archiver	jar	2.1.1

test (1)

Group / Artifact	Type	Version
junit : junit	jar	4.11

Project Modules

There are no modules declared in this project.

md-maven-plugin

Markdown maven plugin integration

How to make a milestone release

> mvn release:prepare -DscmCommentPrefix="[maven-release-plugin] #XX: " -B -DreleaseVersion=1.0.0.MX -DdevelopmentVersion=1.0-SNAPSHOT
[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building Markdown Maven Plugin 1.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO] 
....
[INFO] Release preparation complete.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 30.030s
[INFO] Finished at: Tue Jun 18 17:13:13 CEST 2013
[INFO] Final Memory: 10M/361M
[INFO] ------------------------------------------------------------------------
>
>
>
> mvn release:perform
[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building Markdown Maven Plugin 1.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO] 
.....
[INFO] Cleaning up after release...
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 35.615s
[INFO] Finished at: Tue Jun 18 17:14:17 CEST 2013
[INFO] Final Memory: 10M/361M
[INFO] ------------------------------------------------------------------------

where:

• XX: is the release issue associated to the milestone
• X: is the milestone number

Resources

• https://github.com/sirthias/pegdown

JavaBits

Versions

Version
1.0.0.M3 Mar 3, 2014