Marginalia v0.7.1 Release Notes
Marginalia is an ultra-lightweight literate programming tool for Clojure and ClojureScript inspired by docco*.
To get a quick look at what the output looks like, visit the official Marginalia website.
Usage notes and examples are found on the Marginalia Github page.
Changes from v7.0.0
As always, the prefered way to use Marginalia to generate your documentation is via the lein-marginalia Leiningen plugin, like so:
:dev-dependencies [[lein-marginalia "0.7.1"]]
To run Marginalia, simply run
lein marg <options> <files> in your project's directory.
Marginalia has long supported the generation of documentation where each namespace is contained in its own HTML file. This feature is finally exposed via the command-line/Lein interface and executed as
lein marg --multi <more options> <files>.
- As found in enabling
- Minor stylistic changes in the generated documentation
- More information in the project README
The following capabilities are under design, development, or consideration for future versions of Marginalia:
- Nicer looking
- protocol docstring support
- Stand-alone application
- Explore the possibility of leveraging the ClojureScript analyzer.
- Explore the possibility of leveraging sjacket
- More documentation and examples
More planning is needed around capabilities not listed nor thought of.