2012-03-06 16:46:18 +00:00
Marginalia 0.7.0
================
2011-10-06 05:06:51 +00:00
*Ultra-lightweight literate programming[1] for Clojure inspired by [docco ](http://jashkenas.github.com/docco/ )*
2010-10-26 18:59:47 +00:00
2011-10-06 05:06:51 +00:00
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.
2010-12-21 09:04:49 +00:00
2011-10-06 05:06:51 +00:00
To get a quick look at what marginalia output looks like, [visit the official site ](http://fogus.me/fun/marginalia/ ).
2010-12-21 09:04:49 +00:00
2012-03-06 18:00:28 +00:00
**[View the release notes for this version of Marginalia]()**
2011-01-04 15:34:32 +00:00
Usage
-----
Currently Marginalia can be used in a number of ways as described below.
### Leiningen
2011-06-27 14:51:30 +00:00
[http://github.com/fogus/lein-marginalia ](http://github.com/fogus/lein-marginalia )
2011-10-06 05:06:51 +00:00
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:
2011-01-04 15:34:32 +00:00
2012-03-06 18:00:28 +00:00
:dev-dependencies [lein-marginalia "0.7.0"]
2011-01-04 15:34:32 +00:00
2011-10-06 05:06:51 +00:00
After executing `lein deps` you can generate your complete source documentation with the command:
2011-01-04 15:34:32 +00:00
lein marg
2011-10-06 05:06:51 +00:00
Marginalia accepts other options as described in the *Command Line* section above.
2011-01-04 15:34:32 +00:00
### Maven
2011-10-06 05:06:51 +00:00
The [zi plugin ](https://github.com/pallet/zi ) supports Marginalia.
2011-07-15 18:54:32 +00:00
2011-10-06 05:06:51 +00:00
Add this code to the project's `pom.xml` file, and run the command `mvn zi:marginalia` .
2011-07-15 18:54:32 +00:00
```xml
< plugin >
< groupId > org.cloudhoist.plugin< / groupId >
< artifactId > zi< / artifactId >
2011-07-16 04:12:29 +00:00
< version > 0.3.1< / version >
2011-07-15 18:54:32 +00:00
< configuration >
< marginaliaTargetDirectory > autodoc/marginalia< / marginaliaTargetDirectory >
< / configuration >
< / plugin >
```
2011-10-06 05:06:51 +00:00
And the following to the project's `settings.xml` file.
2011-07-15 18:54:32 +00:00
```xml
< 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 >
```
2011-01-04 15:34:32 +00:00
Contributors and thanks
-----------------------
2011-10-06 05:06:51 +00:00
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.
2011-01-04 15:34:32 +00:00
I would also like to thank Justin Balthrop and Brenton Ashworth for their support and code contributions.
2010-12-21 09:04:49 +00:00
2010-11-16 03:05:32 +00:00
License
-------
2010-10-26 18:59:47 +00:00
2012-03-06 18:00:28 +00:00
Copyright (C) 2010, 2011 Fogus and contributors.
2010-10-26 18:59:47 +00:00
Distributed under the Eclipse Public License, the same as Clojure.
2011-01-04 15:34:32 +00:00
Notes
-----
2011-01-04 15:41:06 +00:00
[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.
2011-03-02 01:55:22 +00:00
Marginalia is...
----------------
*sorted by first commit*
- [Fogus ](http://fogus.me/fun/ )
- [Zachary Kim ](https://github.com/zkim )
- [Justin Balthrop ](https://github.com/ninjudd )
- [Brenton Ashworth ](https://github.com/brentonashworth )
- [Nicolas Buduroi ](https://github.com/budu )
- [Michael Harrison ](https://github.com/goodmike )
2011-07-18 20:17:03 +00:00
- [Anthony Grimes ](https://github.com/Raynes )
2011-09-07 14:05:07 +00:00
- [Sam Ritchie ](https://github.com/fogus/marginalia/commits/master?author=sritchie )
2011-07-16 14:35:05 +00:00
- [Hugo Duncan ](https://github.com/hugoduncan )
2011-08-10 12:35:54 +00:00
- [Vadim ](https://github.com/dm3 )
2011-09-07 01:13:04 +00:00
- [Meikel Brandmeyer ](https://github.com/kotarak )
2011-10-06 12:18:45 +00:00
- [Paul Dorman ](https://github.com/pauldorman )
2012-03-06 18:00:28 +00:00
- [Deepak Giridharagopal ](https://github.com/grimradical )
2011-05-11 13:04:19 +00:00
If I've missed your name then please ping me.