Doxia modules based on Mylyn/Wikitext
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doxia-wikitext-languages
doxia-wikitext-samples
.gitignore
.travis.yml
LICENSE
Makefile
README.textile
pom.xml

README.textile

Doxia WikiText Modules

This collection of Doxia modules enables you to write documentation using one of the languages supported by Mylyn/Wikitext.

Usage

Simply reference one of the modules 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>com.github.sebhoss.doxia</groupId>
      <artifactId>doxia-wikitext-${language}</artifactId>
      <version>${version.wikitext}</version>
    </dependency>
  </dependencies>
</plugin>

Replace ${language} with the desired language/module and ${version.wikitext} with the latest release.

All source documents with the file extension LANGUAGE living under src/site/LANGUAGE/ will be parsed and converted to HTML. Supported languages are:

Language Example
Confluence
Mediawiki
Textile
Tracwiki
TWiki

Development

License

This program is free software. It comes without any warranty, to the extent permitted by applicable law. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2, as published by Sam Hocevar. See LICENSE or http://www.wtfpl.net/ for more details.

Setup

This projects uses Java, Maven 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 this project.

Versioning

This project follows the semantic versioning guidelines.