com.twosigma.znai:znai-utils

Rich documentation generator (markdown and java based)

License

License

GroupId

GroupId

com.twosigma.znai
ArtifactId

ArtifactId

znai-utils
Last Version

Last Version

1.29
Release Date

Release Date

Type

Type

jar
Description

Description

Rich documentation generator (markdown and java based)

Download znai-utils

How to add to project

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

Dependencies

compile (4)

Group / Artifact Type Version
commons-io : commons-io jar 2.6
com.fasterxml.jackson.dataformat : jackson-dataformat-yaml jar 2.10.1
com.fasterxml.jackson.core : jackson-core jar 2.10.1
com.fasterxml.jackson.core : jackson-databind jar 2.10.1

test (4)

Group / Artifact Type Version
com.twosigma.znai : znai-utils-for-testing jar 1.29
junit : junit jar 4.12
org.codehaus.groovy : groovy jar 2.5.7
org.codehaus.groovy : groovy-nio jar 2.5.7

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
com.twosigma.znai

Two Sigma

Versions

Version
1.29
1.27
1.26
1.25
1.24
1.22
1.21
1.20
1.19
1.18
0.16