com.twosigma.znai:znai-maven-plugin

Rich documentation generator (markdown and java based)

License	Apache License, Version 2.0
Categories	Maven Build Tools
GroupId	com.twosigma.znai
ArtifactId	znai-maven-plugin
Last Version	1.29
Release Date	Feb 6, 2020
Type	maven-plugin
Description	Rich documentation generator (markdown and java based)

Download znai-maven-plugin

Filename	Size
znai-maven-plugin-1.29.pom
znai-maven-plugin-1.29.jar	22 KB
znai-maven-plugin-1.29-sources.jar	11 KB
znai-maven-plugin-1.29-javadoc.jar	418 KB

How to add to project

Apache Maven

<plugin>
    <groupId>com.twosigma.znai</groupId>
    <artifactId>znai-maven-plugin</artifactId>
    <version>1.29</version>
</plugin>

Dependencies

compile (3)

Group / Artifact	Type	Version
org.codehaus.groovy : groovy	jar	2.5.7
com.twosigma.znai : znai-cli	jar	1.29
org.apache.maven : maven-plugin-api	jar	3.5.4

provided (2)

Group / Artifact	Type	Version
org.codehaus.groovy : groovy-groovydoc	jar	2.5.7
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.5.2

test (2)

Group / Artifact	Type	Version
junit : junit	jar	4.12
com.twosigma.webtau : webtau-core-groovy	jar	1.16

Project Modules

There are no modules declared in this project.

Znai

Znai transforms Markdown files into rich, well-structured documentation served in a web front-end built on React. It provides many custom add-ons that supercharge basic generated docs with advanced layout features, dynamic references to code and test artifacts, and many visual and functional enhancements.

User guide: https://testingisdocumenting.org/znai/

Developer Setup

Build requires "dot" from the graphviz project to be available on the $PATH.

MacOS

brew install graphviz

Ubuntu/Debian

sudo apt-get install graphviz

Two Sigma

Versions

Version
1.29 Feb 6, 2020
1.27 Feb 6, 2020
1.26 Feb 5, 2020
1.25 Feb 5, 2020
1.24 Feb 5, 2020
1.22 Jan 17, 2020
1.21 Nov 26, 2019
1.20 Oct 3, 2019
1.19 Oct 3, 2019
1.18 Oct 1, 2019
0.16 Aug 10, 2019