Skip to content

Commit 8f95e28

Browse files
committed
preparing for 9.1 release
1 parent 7bc877a commit 8f95e28

File tree

3 files changed

+61
-7
lines changed

3 files changed

+61
-7
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Marginalia 0.9.0
1+
Marginalia 0.9.1
22
================
33

44
**[Marginalia has a new home](http://blog.fogus.me/2013/08/12/marginalia-has-a-new-home/)**
@@ -11,7 +11,7 @@ Marginalia is a source code documentation tool that parses Clojure and ClojureSc
1111

1212
To get a quick look at what the Marginalia output looks like, [visit the official site](http://gdeer81.github.io/marginalia/).
1313

14-
**[View the release notes for this version of Marginalia](https://github.com/gdeer81/marginalia/blob/master/docs/release-notes/marginalia-v0.7.1-release-notes.markdown)**
14+
**[View the release notes for this version of Marginalia](https://github.com/gdeer81/marginalia/blob/master/docs/release-notes/marginalia-v0.9.1-release-notes.markdown)**
1515

1616
Usage
1717
-----
@@ -24,8 +24,8 @@ Currently Marginalia can be used in a number of ways as described below.
2424

2525
To use Marginalia with Leiningen add the following code to the project's `project.clj` file:
2626

27-
With Leiningen 1.x, add `[lein-marginalia "0.9.0"]` to your project.clj's `:dev-dependencies` argument of the `defproject` function, then run `lein deps`.
28-
With Leiningen 2.x, add `[[lein-marginalia "0.9.0"]]` to the `:plugins` entry in either your project.clj file or your `:user` profile.
27+
With Leiningen 1.x, add `[lein-marginalia "0.9.1"]` to your project.clj's `:dev-dependencies` argument of the `defproject` function, then run `lein deps`.
28+
With Leiningen 2.x, add `[[lein-marginalia "0.9.1"]]` to the `:plugins` entry in either your project.clj file or your `:user` profile.
2929
See the [lein-marginalia](http://github.com/gdeer81/lein-marginalia) page for more details.
3030

3131
Once installed, you can generate your complete source documentation with the command:
@@ -49,7 +49,8 @@ Marginalia accepts options as described below:
4949

5050
The [zi plugin](https://github.com/pallet/zi) supports Marginalia.
5151

52-
Add this code to the project's `pom.xml` file, and run the command `mvn zi:marginalia`.
52+
<details>
53+
<summary>Add this code to the project's `pom.xml` file, and run the command `mvn zi:marginalia`.</summary>
5354

5455
```xml
5556
<plugin>
@@ -85,6 +86,7 @@ And the following to the project's `settings.xml` file.
8586
<activeProfile>clojure-dev</activeProfile>
8687
</activeProfiles>
8788
```
89+
</details>
8890

8991
Contributors and thanks
9092
-----------------------
@@ -128,6 +130,6 @@ If I've missed your name then please ping me.
128130
License
129131
-------
130132

131-
Copyright (C) 2010-2015 Fogus and contributors.
133+
Copyright (C) 2010-2017 Gary, Fogus and contributors.
132134

133135
Distributed under the Eclipse Public License, the same as Clojure.
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
Marginalia v0.9.1 Release Notes
2+
===============================
3+
4+
Marginalia is an ultra-lightweight literate programming tool for Clojure and ClojureScript inspired by [docco](http://jashkenas.github.com/docco/)*.
5+
6+
To get a quick look at what the output looks like, [visit the official Marginalia website](http://fogus.me/fun/marginalia/).
7+
8+
**Usage notes and examples are found on the [Marginalia Github page](http://github.com/gdeer81/marginalia).**
9+
10+
Places
11+
------
12+
13+
* [Source code](https://github.com/gdeer81/marginalia)
14+
* [Ticket system](https://github.com/gdeer81/marginalia/issues)
15+
* [manifesto](http://blog.fogus.me/2011/01/05/the-marginalia-manifesto/)
16+
17+
Changes from v0.8.0
18+
-------------------
19+
20+
### lein-marginalia
21+
22+
As always, the prefered way to use Marginalia to generate your documentation is via the [lein-marginalia](http://github.com/fogus/lein-marginalia) Leiningen plugin, like so:
23+
24+
:dev-dependencies [[lein-marginalia "0.9.1"]]
25+
26+
To run Marginalia, simply run `lein marg <options> <files>` in your project's directory.
27+
28+
### Multidoc Generation
29+
30+
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>`.
31+
32+
### Bug fixes
33+
34+
* Fix no newline at the end of parser.clj.
35+
* Fix no namespace extracted from .cljx files.
36+
* Add support for cljx reader tags #+clj and #+cljs to make it possible
37+
* handle (ignore) extra args from LispReader
38+
* fixed regex helper
39+
40+
41+
Plans
42+
-----
43+
44+
The following capabilities are under design, development, or consideration for future versions of Marginalia:
45+
46+
* Nicer looking `toc.html` generation in `--multi` mode output.
47+
* protocol docstring support
48+
* Explore the possibility of leveraging the [ClojureScript](http://github.com/clojure/clojurescript) analyzer.
49+
* Explore the possibility of leveraging [sjacket](https://github.com/cgrand/sjacket)
50+
* More documentation and examples
51+
52+
More planning is needed around capabilities not listed nor thought of.

project.clj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
(defproject marginalia "0.9.0"
1+
(defproject marginalia "0.9.1"
22
:description "lightweight literate programming for clojure -- inspired by [docco](http://jashkenas.github.com/docco/)"
33
;; :main marginalia.main
44
:dependencies

0 commit comments

Comments
 (0)