Skip to content
Generate Clojure documentation from your project's classpath and serve it through a local web server.
CSS Clojure
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
indexer
resources/public
src
.gitignore
README.md
project.clj

README.md

cloc

Cloc is a Clojure documentation tool, similar to PyDoc's local webserver feature. It will use the excellent Codox library to scan your source code and dependencies for docstrings, then server those docs through a web UI, on a local web server. It also packs a fast, Lucene-powered search index, because documentation tools that don't have a search are just wrong.

Screenshot

Usage

The idea is that you add Cloc as a plugin to your :user profile for Leiningen. In ~/.lein/profiles.clj:

   {:user
    {:plugins [[cloc "0.1.0"]}}

That will make the Leiningen plugin available in all your projects. So, from some Leiningen project that you're working on, just run:

$ lein cloc

You should see some logging, then after a few seconds it'll tell you the webserver is running.

License

Copyright © 2013 James Aley

Distributed under the Eclipse Public License, the same as Clojure.

Something went wrong with that request. Please try again.