https://github.com/agrison/scalocco

Scalocco, a quick and dirty implementation of Docco in Scala
https://github.com/agrison/scalocco

Last synced: about 1 year ago
JSON representation

Scalocco, a quick and dirty implementation of Docco in Scala

• Host: GitHub
• URL: https://github.com/agrison/scalocco
• Owner: agrison
• Created: 2013-03-22T05:44:11.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2013-07-21T19:08:43.000Z (almost 13 years ago)
• Last Synced: 2025-04-09T06:05:28.200Z (about 1 year ago)
• Language: Scala
• Size: 182 KB
• Stars: 9
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
     ______     ______     ______     __         ______     ______     ______     ______    

    /\  ___\   /\  ___\   /\  __ \   /\ \       /\  __ \   /\  ___\   /\  ___\   /\  __ \   

    \ \___  \  \ \ \____  \ \  __ \  \ \ \____  \ \ \/\ \  \ \ \____  \ \ \____  \ \ \/\ \  

     \/\_____\  \ \_____\  \ \_\ \_\  \ \_____\  \ \_____\  \ \_____\  \ \_____\  \ \_____\ 

      \/_____/   \/_____/   \/_/\/_/   \/_____/   \/_____/   \/_____/   \/_____/   \/_____/

    

                             Scala implementation of Docco

                             -----------------------------

             Produces HTML pages that displays your comments alongside your code.

**Scalocco** is a really quick-and-dirty, literate-programming-style documentation

generator. It is a Scala port of [Docco](http://jashkenas.github.com/docco/),

which was written by [Jeremy Ashkenas](https://github.com/jashkenas) in

Coffescript and runs on node.js.

Scalocco produces HTML that displays your comments alongside your code.

Comments are passed through

[Markdown](http://daringfireball.net/projects/markdown/syntax), and code is

highlighted using [google-code-prettify](http://code.google.com/p/google-code-prettify/)

syntax highlighting.

Currently, to build Scalocco, you'll need [sbt](http://www.scala-sbt.org/release/docs/Getting-Started/Setup.html) and **scala**. The project

depends on [scala-mustache](https://github.com/vspy/scala-mustache) and [Markdown4j](https://code.google.com/p/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](https://github.com/dontangg/nocco)

You can see the result of running Scalocco on its own source code here: [http://grison.me/scalocco/source](http://grison.me/scalocco/source)