Skip to content

Commit

Permalink
preparing for 9.1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
gdeer81 committed Nov 9, 2017
1 parent 7bc877a commit 8f95e28
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 7 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Marginalia 0.9.0
Marginalia 0.9.1
================

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

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

**[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)**
**[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)**

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

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

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`.
With Leiningen 2.x, add `[[lein-marginalia "0.9.0"]]` to the `:plugins` entry in either your project.clj file or your `:user` profile.
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`.
With Leiningen 2.x, add `[[lein-marginalia "0.9.1"]]` to the `:plugins` entry in either your project.clj file or your `:user` profile.
See the [lein-marginalia](http://github.com/gdeer81/lein-marginalia) page for more details.

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

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

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

```xml
<plugin>
Expand Down Expand Up @@ -85,6 +86,7 @@ And the following to the project's `settings.xml` file.
<activeProfile>clojure-dev</activeProfile>
</activeProfiles>
```
</details>

Contributors and thanks
-----------------------
Expand Down Expand Up @@ -128,6 +130,6 @@ If I've missed your name then please ping me.
License
-------

Copyright (C) 2010-2015 Fogus and contributors.
Copyright (C) 2010-2017 Gary, Fogus and contributors.

Distributed under the Eclipse Public License, the same as Clojure.
52 changes: 52 additions & 0 deletions docs/release-notes/marginalia-v0.9.1-release-notes.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
Marginalia v0.9.1 Release Notes
===============================

Marginalia is an ultra-lightweight literate programming tool for Clojure and ClojureScript 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/gdeer81/marginalia).**

Places
------

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

Changes from v0.8.0
-------------------

### lein-marginalia

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:

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

To run Marginalia, simply run `lein marg <options> <files>` in your project's directory.

### Multidoc Generation

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>`.

### Bug fixes

* Fix no newline at the end of parser.clj.
* Fix no namespace extracted from .cljx files.
* Add support for cljx reader tags #+clj and #+cljs to make it possible
* handle (ignore) extra args from LispReader
* fixed regex helper


Plans
-----

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

* Nicer looking `toc.html` generation in `--multi` mode output.
* protocol docstring support
* Explore the possibility of leveraging the [ClojureScript](http://github.com/clojure/clojurescript) analyzer.
* Explore the possibility of leveraging [sjacket](https://github.com/cgrand/sjacket)
* More documentation and examples

More planning is needed around capabilities not listed nor thought of.
2 changes: 1 addition & 1 deletion project.clj
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(defproject marginalia "0.9.0"
(defproject marginalia "0.9.1"
:description "lightweight literate programming for clojure -- inspired by [docco](http://jashkenas.github.com/docco/)"
;; :main marginalia.main
:dependencies
Expand Down

0 comments on commit 8f95e28

Please sign in to comment.