Znai

Rich documentation generator (markdown and java based)

License	Apache License, Version 2.0
GroupId	com.twosigma.znai
ArtifactId	znai-parent
Last Version	1.29
Release Date	Feb 6, 2020
Type	pom
Description	Znai Rich documentation generator (markdown and java based)
Project URL	https://github.com/twosigma/znai
Source Code Management	https://github.com/twosigma/znai

Download znai-parent

Filename	Size
znai-parent-1.29.pom	21 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.twosigma.znai/znai-parent/ -->
<dependency>
    <groupId>com.twosigma.znai</groupId>
    <artifactId>znai-parent</artifactId>
    <version>1.29</version>
    <type>pom</type>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.twosigma.znai/znai-parent/
implementation 'com.twosigma.znai:znai-parent:1.29'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.twosigma.znai/znai-parent/
implementation ("com.twosigma.znai:znai-parent:1.29")

Apache Buildr

'com.twosigma.znai:znai-parent:pom:1.29'

Apache Ivy

<dependency org="com.twosigma.znai" name="znai-parent" rev="1.29">
  <artifact name="znai-parent" type="pom" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.twosigma.znai', module='znai-parent', version='1.29')
)

Scala SBT

libraryDependencies += "com.twosigma.znai" % "znai-parent" % "1.29"

Leiningen

[com.twosigma.znai/znai-parent "1.29"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

• znai-utils
• znai-utils-for-testing
• znai-console
• znai-testing-tcli
• znai-ddjt-docs
• znai-diagrams
• znai
• znai-site-extensions
• znai-core
• znai-latex
• znai-java
• znai-groovy
• znai-cpp
• znai-ecmascript
• znai-sphinx
• znai-open-api
• znai-typescript
• znai-jupyter
• znai-reactjs-api
• znai-reactjs
• znai-server
• znai-client
• znai-cli
• znai-generators
• znai-maven-plugin
• znai-docs
• znai-testing-examples
• znai-shaded
• znai-dist

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