deesceha / doxia-module-textile

Maven Doxia module for Textile source documents

Doxia Textile module

This Doxia module enables you to write documentation using the Textile syntax. It is based on the Mylyn/WikiText project which also provides a nice editor with syntax completion, folding, validation, outline view and a preview of what the HTML output looks like.

Usage

Simply reference this module as a dependency to the maven-site-plugin inside your POM:

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-site-plugin</artifactId>
  <dependencies>
    <dependency>
      <groupId>de.viadee.maven.doxia</groupId>
      <artifactId>doxia-module-textile</artifactId>
      <version>1.0.0-SNAPSHOT</version>
    </dependency>
  </dependencies>
</plugin>

All Textile source documents with the file extension textile living under src/site/textile/ will be parsed and converted to HTML.

Development

License

This project is licensed under the Apache Software License, Version 2.0.

Setup

This project is using Maven, Eclipse and Git as the main development tools. To build the project yourself just download & install at least Maven 3.0 and call mvn install inside the project folder. Maven should then proceed to clean, build, package and install the doxia module.

Versioning

This project follows the semantic versioning guidelines.