ultra-lightweight literate programming for clojure inspired by docco
Marginalia is a source documentation too that parses Clojure code and outputs an side-by-side source view with appropriate comments and docstrings aligned.
To get a quick look at what marginalia output looks like, then visit the official site.
Currently Marginalia can be used in a number of ways as described below.
You can download the Marginalia 0.6.0 jar including packaged dependencies from Github.
Running Marginalia given the jar file linked above is as easy as:
java -jar marginalia-0.6.0-standalone.jar
This will search the
PWD for a
src directory which it will then traverse looking for Clojure source files to parse and generate documentation for. Marginalia also takes specific locations and files to generate docs for:
java -jar marginalia-0.6.0-standalone.jar <file1> <file2> ... <filen>
Arguments can be specific files or directories.
To use Marginalia in your own projects simply add the following to your
project.clj file in the
lein deps you can generate your complete source documentation with the following command:
Marginalia accepts other options as outlined in the Command Line section above.
Add the following to your project's
Also, you need to add it to your task list:
Here's a sample
(defproject my-project "0.1.0 :description "Cake plugin for Marginalia." :dependencies [[org.clojure/clojure "1.2.1"] [org.clojure/clojure-contrib "1.2.0"]] :dev-dependencies [[marginalia "0.6.0"] [cake-marginalia "0.6.0"]] :tasks [cake-marginalia.tasks])
After that, you should be able to use it like any other cake task:
The zi plugin supports marginalia.
Add the folowing to your
pom.xml, and run
<plugin> <groupId>org.cloudhoist.plugin</groupId> <artifactId>zi</artifactId> <version>0.3.1</version> <configuration> <marginaliaTargetDirectory>autodoc/marginalia</marginaliaTargetDirectory> </configuration> </plugin>
And the following to your
<pluginGroups> <pluginGroup>org.cloudhoist.plugin</pluginGroup> </pluginGroups> <profiles> <profile> <id>clojure-dev</id> <pluginRepositories> <pluginRepository> <id>sonatype-snapshots</id> <url>http://oss.sonatype.org/content/repositories/releases</url> </pluginRepository> </pluginRepositories> </profile> </profiles> <activeProfiles> <activeProfile>clojure-dev</activeProfile> </activeProfiles>
Contributors and thanks
I would like to thank Zachary Kim for taking a pile of incoherant 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.
- paragraph anchors
- options for non-uber-docs
- Maven generation support
- POM parsing
Copyright (C) 2010 Fogus
Distributed under the Eclipse Public License, the same as Clojure.
 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.
sorted by first commit
- Zachary Kim
- Justin Balthrop
- Brenton Ashworth
- Nicolas Buduroi
- Michael Harrison
- Anthony Grimes
- Hugo Duncan
If I've missed your name then please ping me.