com.twosigma.znai:znai

Rich documentation generator (markdown and java based)

License

License

GroupId

GroupId

com.twosigma.znai
ArtifactId

ArtifactId

znai
Last Version

Last Version

1.29
Release Date

Release Date

Type

Type

jar
Description

Description

Rich documentation generator (markdown and java based)

Download znai

How to add to project

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

Dependencies

compile (17)

Group / Artifact Type Version
com.twosigma.znai : znai-core jar 1.29
com.twosigma.znai : znai-site-extensions jar 1.29
com.twosigma.znai : znai-java jar 1.29
com.twosigma.znai : znai-groovy jar 1.29
com.twosigma.znai : znai-latex jar 1.29
com.twosigma.znai : znai-cpp jar 1.29
com.twosigma.znai : znai-open-api jar 1.29
com.twosigma.znai : znai-typescript jar 1.29
com.twosigma.znai : znai-jupyter jar 1.29
com.twosigma.znai : znai-sphinx jar 1.29
com.twosigma.znai : znai-reactjs jar 1.29
com.twosigma.znai : znai-diagrams jar 1.29
com.twosigma.znai : znai-console jar 1.29
com.twosigma.znai : znai-utils jar 1.29
com.jayway.jsonpath : json-path jar 2.4.0
commons-io : commons-io jar 2.6
org.slf4j : slf4j-simple jar 1.7.25

test (3)

Group / Artifact Type Version
com.twosigma.znai : znai-core test-jar 1.29
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
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