Skip to content

Latest commit

 

History

History
152 lines (103 loc) · 4.94 KB

README.md

File metadata and controls

152 lines (103 loc) · 4.94 KB
Raw

Marginalia 0.6.1

Ultra-lightweight literate programming[1] for Clojure inspired by docco

Marginalia is a source code documentation tool that parses Clojure code and outputs a side-by-side source view with appropriate comments and docstrings aligned.

To get a quick look at what marginalia output looks like, visit the official site.

Usage

Currently Marginalia can be used in a number of ways as described below.

Command Line

You can download the Marginalia 0.6.1 jar including packaged dependencies from Github.

Running Marginalia given the jar file linked above is as easy as:

java -jar marginalia-0.6.1-standalone.jar

This will search the $PWD (current working directory) for a src directory, which it will then traverse looking for Clojure source files to generate documentation for. Marginalia can also take specified directories and/or files for which to generate documentation:

java -jar marginalia-0.6.1-standalone.jar <path1> <path2> ... <pathn>

Path arguments may refer to files or directories.

Leiningen

http://github.com/fogus/lein-marginalia

To use Marginalia with Leiningen add the following code to the project's project.clj file, in the :dev-dependencies argument of the defproject function:

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

After executing lein deps you can generate your complete source documentation with the command:

lein marg

Marginalia accepts other options as described in the Command Line section above.

Cake

http://github.com/fogus/cake-marginalia

To use Marginalia with Cake add the following code to the project's project.clj file, in the :dev-dependencies argument of the defproject function:

:dev-dependencies [cake-marginalia "0.6.0"]

Also, you need add this code to the :tasks argument for the defproject function:

:tasks [cake-marginalia.tasks]

Here's an example project.clj file:

(defproject my-project "0.1.0
  :description "Cake plugin for Marginalia."
  :dependencies [[org.clojure/clojure "1.2.1"]
                 [org.clojure/clojure-contrib "1.2.0"]]
  :dev-dependencies [[marginalia "0.6.1"]
                     [cake-marginalia "0.6.0"]]
  :tasks [cake-marginalia.tasks])

Marginalia is called like any other Cake task:

cake marg

Maven

The zi plugin supports Marginalia.

Add this code to the project's pom.xml file, and run the command mvn zi:marginalia.

    <plugin>
      <groupId>org.cloudhoist.plugin</groupId>
      <artifactId>zi</artifactId>
      <version>0.3.1</version>
      <configuration>
        <marginaliaTargetDirectory>autodoc/marginalia</marginaliaTargetDirectory>
      </configuration>
    </plugin>

And the following to the project's settings.xml file.

    <pluginGroups>
      <pluginGroup>org.cloudhoist.plugin</pluginGroup>
    </pluginGroups>

    <profiles>
      <profile>
        <id>clojure-dev</id>
        <pluginRepositories>
          <pluginRepository>
            <id>sonatype-snapshots</id>
            <url>http://oss.sonatype.org/content/repositories/releases</url>
          </pluginRepository>
        </pluginRepositories>
      </profile>
    </profiles>

    <activeProfiles>
      <activeProfile>clojure-dev</activeProfile>
    </activeProfiles>

Contributors and thanks

I would like to thank Zachary Kim for taking a pile of incoherent code and making it something worth using. Marginalia would be nothing without his hard work and vision.

I would also like to thank Justin Balthrop and Brenton Ashworth for their support and code contributions.

TODO

  • paragraph anchors
  • options for non-uber-docs
  • Maven generation support
  • POM parsing

License

Copyright (C) 2010, 2011 Fogus

Distributed under the Eclipse Public License, the same as Clojure.

Notes

[1] While the phrase ultra-lightweight literate programming is used to describe Marginalia, it is in no way a tool for classical literate programming. That is, Marginalia is a linear documentation generator allowing no out-of-order reassembly of source.

Marginalia is...

sorted by first commit

If I've missed your name then please ping me.