1. Julien Nicoulaud
  2. doxia-module-markdown

Overview

doxia-module-markdown

Maven Doxia module for Markdown.

This module allows to use Markdown for writing Maven sites.

How to use

  • Add this module as a dependency of maven-site-plugin:

    <project>
      <build>
        <plugins>
          <plugin>
            <artifactId>maven-site-plugin</artifactId>
            <dependencies>
              <dependency>
                <groupId>net.ju-n.maven.doxia</groupId>
                <artifactId>doxia-module-markdown</artifactId>
                <version>1.0.1-SNAPSHOT</version>
              </dependency>
            </dependencies>
          </plugin>
        </plugins>
      </build>
    </project>
    
  • Put your Markdown documents in the markdown directory with the .md or .md.vm extension:

    ├── src
    │   ├── site
    │   │   ├── markdown
    │   │   │   └── index.md
    │   │   │   └── page1.md
    │   │   │   └── page2.md.vm
    │   │   │   └── page3.md