Docs is a simple documentation written in Scala. Docs is inspired by MdBook and MkDocs, and it is not difficult to port documentation to Docs.

Use the following definition to use Docs in your Maven project:

<repository>
  <id>hyperreal</id>
  <url>https://dl.bintray.com/edadma/maven</url>
</repository>

<dependency>
  <groupId>xyz.hyperreal</groupId>
  <artifactId>docs</artifactId>
  <version>0.1</version>
</dependency>

Add the following to your build.sbt file to use Docs in your SBT project:

resolvers += "Hyperreal Repository" at "https://dl.bintray.com/edadma/maven"

libraryDependencies += "xyz.hyperreal" %% "docs" % "0.1"

An executable can be downloaded from here. You do not need the Scala library for it to work because the JAR already contains all dependencies. You just need Java 8+ installed.

Run it as a normal Java executable JAR with the command java -jar docs-0.1.jar init <path> in the folder where you downloaded the file, where path is the path to the documentation project folder.

• Java 8
• SBT 1.1.6+
• Scala 2.12.6+

git clone git://github.com/edadma/docs.git
cd docs
sbt assembly

The command sbt assembly also runs all the unit tests.

ISC © 2018 Edward A. Maxedon, Sr.