Doxia :: Textile Module

Doxia module for Textile source documents

License

License

GroupId

GroupId

com.github.sebhoss
ArtifactId

ArtifactId

doxia-module-textile
Last Version

Last Version

1.1.0
Release Date

Release Date

Type

Type

jar
Description

Description

Doxia :: Textile Module
Doxia module for Textile source documents
Project URL

Project URL

https://github.com/sebhoss/doxia-module-textile
Source Code Management

Source Code Management

https://github.com/sebhoss/doxia-module-textile

Download doxia-module-textile

How to add to project

<!-- https://jarcasting.com/artifacts/com.github.sebhoss/doxia-module-textile/ -->
<dependency>
    <groupId>com.github.sebhoss</groupId>
    <artifactId>doxia-module-textile</artifactId>
    <version>1.1.0</version>
</dependency>
// https://jarcasting.com/artifacts/com.github.sebhoss/doxia-module-textile/
implementation 'com.github.sebhoss:doxia-module-textile:1.1.0'
// https://jarcasting.com/artifacts/com.github.sebhoss/doxia-module-textile/
implementation ("com.github.sebhoss:doxia-module-textile:1.1.0")
'com.github.sebhoss:doxia-module-textile:jar:1.1.0'
<dependency org="com.github.sebhoss" name="doxia-module-textile" rev="1.1.0">
  <artifact name="doxia-module-textile" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.github.sebhoss', module='doxia-module-textile', version='1.1.0')
)
libraryDependencies += "com.github.sebhoss" % "doxia-module-textile" % "1.1.0"
[com.github.sebhoss/doxia-module-textile "1.1.0"]

Dependencies

compile (7)

Group / Artifact Type Version
org.fusesource.wikitext : wikitext-core jar
org.fusesource.wikitext : textile-core jar
com.google.guava : guava jar
org.apache.maven.doxia : doxia-core jar
org.apache.maven.doxia : doxia-sink-api jar
org.codehaus.plexus : plexus-component-annotations jar 1.5.5
javax.inject : javax.inject jar

test (2)

Group / Artifact Type Version
junit : junit jar
org.apache.maven.doxia : doxia-core test-jar

Project Modules

There are no modules declared in this project.

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.

Versions

Version
1.1.0