Marginalia v0.7.0 Release Notes
===============================

Marginalia is an ultra-lightweight literate programming tool for Clojure 
inspired by [docco](http://jashkenas.github.com/docco/)*.

To get a quick look at what the output looks like, [visit the official 
Marginalia website](http://fogus.me/fun/marginalia/).

**Usage notes and examples are found on the [Marginalia Github 
page](http://github.com/fogus/marginalia).**

Places
------

* [Source code](https://github.com/fogus/marginalia)
* [Ticket system](https://github.com/fogus/marginalia/issues)
* [manifesto](http://blog.fogus.me/2011/01/05/the-marginalia-manifesto/)

Changes from v6.0.1
-------------------

### lein-marginalia

Version 0.7.0 is an attempt to move toward Marginalia as library only.  
Therefore, the Leiningen support has been pulled out and placed into its own 
plugin named [lein-marginalia](http://github.com/fogus/lein-marginalia).  To 
use Marginalia to generate documentation for your own projects you should no 
longer reference Marginalia in your `project.clj`.  Instead, use 
lein-marginalia in your `:dev-dependencies` section like so:

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

Leiningen will pull in the proper Marginalia version.  We will attempt to keep 
the version numbers in sync.

### ClojureScript support

Marginalia will now discover and parse ClojureScript files.

### def docstrings

Clojure 1.3 allows docstrings in `def` forms that look like:

    (def a-var value "The docstring")

Marginalia will recognize this pattern and generate the associate documentation.

### Wildcard arguments

Marginalia will accept wildcard arguments in place of absolute source paths.  
For example, to generate docs for all source files with an 'r' in the name, you 
could type:

    lein marg src/**/*r*.clj

You can pass any number of arguments to the `marg` task.

### Bug fixes

* Prefixed keywords (#54 and #87)
* [`project.clj` requirement](https://github.com/fogus/marginalia/issues/20)
* [`^:private support`](https://github.com/fogus/marginalia/issues/49)
* [Comment code blocks](https://github.com/fogus/marginalia/issues/50)
* [`:requires` bug](https://github.com/fogus/marginalia/issues/55)


Plans
-----

The following capabilities are under design, development, or consideration for 
future versions of Marginalia:

* protocol docstring support
* Stand-alone application
* Explore the possibility of leveraging the 
[ClojureScript](http://github.com/clojure/clojurescript) analyzer.
* More documentation and examples

More planning is needed around capabilities not listed nor thought of.


-- 
You received this message because you are subscribed to the Google
Groups "Clojure" group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your 
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en

Reply via email to