Skip to content
This repository


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

ultra-lightweight literate programming for clojure inspired by docco

This branch is 0 commits ahead and 0 commits behind master

Fetching latest commit…


Cannot retrieve the latest commit at this time

Octocat-spinner-32 docs
Octocat-spinner-32 site
Octocat-spinner-32 src
Octocat-spinner-32 test
Octocat-spinner-32 test_projects
Octocat-spinner-32 vendor
Octocat-spinner-32 .gitignore
Octocat-spinner-32 project.clj


Marginalia v0.7.0

Ultra-lightweight literate programming[1] for Clojure inspired by docco

Marginalia is a source code documentation tool that parses Clojure code and outputs a side-by-side source view with appropriate comments and docstrings aligned.

To get a quick look at what marginalia output looks like, visit the official site.

View the release notes for this version of Marginalia


Currently Marginalia can be used in a number of ways as described below.


To use Marginalia with Leiningen add the following code to the project's project.clj file, in the :dev-dependencies argument of the defproject function:

:dev-dependencies [lein-marginalia "0.7.0"]

After executing lein deps you can generate your complete source documentation with the command:

lein marg

Marginalia accepts other options as described in the Command Line section above.


The zi plugin supports Marginalia.

Add this code to the project's pom.xml file, and run the command mvn zi:marginalia.


And the following to the project's settings.xml file.




Contributors and thanks

I would like to thank Zachary Kim for taking a pile of incoherent code and making it something worth using. Marginalia would be nothing without his hard work and vision.

I would also like to thank Justin Balthrop and Brenton Ashworth for their support and code contributions.


Copyright (C) 2010, 2011 Fogus and contributors.

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


[1] While the phrase ultra-lightweight literate programming is used to describe Marginalia, it is in no way a tool for classical literate programming. That is, Marginalia is a linear documentation generator allowing no out-of-order reassembly of source.

Marginalia is...

sorted by first commit

If I've missed your name then please ping me.

Something went wrong with that request. Please try again.