Scalocco is a really quick-and-dirty, literate-programming-style documentation generator. It is a Scala port of Docco, which was written by Jeremy Ashkenas in Coffescript and runs on node.js.

Scalocco produces HTML that displays your comments alongside your code. Comments are passed through Markdown, and code is highlighted using google-code-prettify syntax highlighting.

Currently, to build Scalocco, you’ll need sbt and scala. The project depends on scala-mustache and Markdown4j

To run Scalocco, just use sbt:

sbt "run /path/to/scala/files"

…will generate linked HTML documentation for the named source files, saving it into a docs folder.

The visual style was borrowed from the .Net implementation of Docco: Nocco

You can see the result of running Scalocco on its own source code here:

GitHub project

You can browse the project on my GitHub repository [@agrison/scalocco][8].


You can see the outpout of Scalocco on its own source files here:



Alexandre Grison - // - @algrison