You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
Marginalia 0.9.0
1
+
Marginalia 0.9.1
2
2
================
3
3
4
4
**[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
11
11
12
12
To get a quick look at what the Marginalia output looks like, [visit the official site](http://gdeer81.github.io/marginalia/).
13
13
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)**
15
15
16
16
Usage
17
17
-----
@@ -24,8 +24,8 @@ Currently Marginalia can be used in a number of ways as described below.
24
24
25
25
To use Marginalia with Leiningen add the following code to the project's `project.clj` file:
26
26
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.
29
29
See the [lein-marginalia](http://github.com/gdeer81/lein-marginalia) page for more details.
30
30
31
31
Once installed, you can generate your complete source documentation with the command:
@@ -49,7 +49,8 @@ Marginalia accepts options as described below:
49
49
50
50
The [zi plugin](https://github.com/pallet/zi) supports Marginalia.
51
51
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>
53
54
54
55
```xml
55
56
<plugin>
@@ -85,6 +86,7 @@ And the following to the project's `settings.xml` file.
85
86
<activeProfile>clojure-dev</activeProfile>
86
87
</activeProfiles>
87
88
```
89
+
</details>
88
90
89
91
Contributors and thanks
90
92
-----------------------
@@ -128,6 +130,6 @@ If I've missed your name then please ping me.
128
130
License
129
131
-------
130
132
131
-
Copyright (C) 2010-2015 Fogus and contributors.
133
+
Copyright (C) 2010-2017 Gary, Fogus and contributors.
132
134
133
135
Distributed under the Eclipse Public License, the same as Clojure.
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.
0 commit comments