marginalia
所属分类:collect
开发工具:HTML
文件大小:0KB
下载次数:0
上传日期:2022-10-18 22:38:22
上 传 者:
sh-1993
说明: 受docco启发,针对clojure的超轻量级识字编程,
(ultra-lightweight literate programming for clojure inspired by docco,)
文件列表:
ORIGINATOR (7, 2023-11-07)
docs/ (0, 2023-11-07)
docs/release-notes/ (0, 2023-11-07)
docs/release-notes/marginalia-v0.7.0-release-notes.markdown (2640, 2023-11-07)
docs/release-notes/marginalia-v0.7.1-release-notes.markdown (2017, 2023-11-07)
docs/release-notes/marginalia-v0.8.0-release-notes.markdown (2287, 2023-11-07)
docs/release-notes/marginalia-v0.9.1-release-notes.markdown (2089, 2023-11-07)
docs/uberdoc.html (232926, 2023-11-07)
epl-v10.html (12654, 2023-11-07)
project.clj (1264, 2023-11-07)
site/ (0, 2023-11-07)
site/Rakefile (1996, 2023-11-07)
site/config.yaml (1209, 2023-11-07)
site/ext/ (0, 2023-11-07)
site/ext/init.rb (470, 2023-11-07)
site/src/ (0, 2023-11-07)
site/src/browserfix.css (123, 2023-11-07)
site/src/default.css (1349, 2023-11-07)
site/src/default.template (5301, 2023-11-07)
site/src/images/ (0, 2023-11-07)
site/src/images/labyrinth.ico (2870, 2023-11-07)
site/src/images/spacer.gif (43, 2023-11-07)
site/src/index.page (4913, 2023-11-07)
site/src/uberdoc.html (195761, 2023-11-07)
src/ (0, 2023-11-07)
src/marginalia/ (0, 2023-11-07)
src/marginalia/core.clj (13218, 2023-11-07)
src/marginalia/hiccup.clj (9629, 2023-11-07)
src/marginalia/html.clj (15277, 2023-11-07)
src/marginalia/latex.clj (3683, 2023-11-07)
src/marginalia/main.clj (779, 2023-11-07)
src/marginalia/parser.clj (18511, 2023-11-07)
src/problem_cases/ (0, 2023-11-07)
... ...
Marginalia 0.9.1
================
[![Clojars Project](https://img.shields.io/clojars/v/marginalia.svg)](https://clojars.org/marginalia)
**[Marginalia has a new home](http://blog.fogus.me/2013/08/12/marginalia-has-a-new-home/)**
![marginalia](http://farm8.staticflickr.com/7057/6828224448_32b51e5784_z_d.jpg "Marginalia")
*Ultra-lightweight literate programming[1] for [Clojure](http://clojure.org) and ClojureScript inspired by [docco](http://jashkenas.github.io/docco/)*
Marginalia is a source code documentation tool that parses Clojure and ClojureScript code and outputs a side-by-side source view with appropriate comments and docstrings aligned.
To get a quick look at what the Marginalia output looks like, [visit the official site](https://clj-commons.org/marginalia/).
**[View the release notes for this version of Marginalia](https://github.com/clj-commons/marginalia/blob/master/docs/release-notes/marginalia-v0.9.1-release-notes.markdown)**
Usage
-----
Currently Marginalia can be used in a number of ways as described below.
### Leiningen
[https://github.com/clj-commons/lein-marginalia](https://github.com/clj-commons/lein-marginalia)
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.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](https://github.com/clj-commons/lein-marginalia) page for more details.
Once installed, you can generate your complete source documentation with the command:
lein marg
Marginalia accepts options as described below:
* -d --dir Directory into which the documentation will be written (default `docs`)
* -f --file File into which the documentation will be written (default `uberdoc.html`)
* -n --name Project name (if not given will be taken from `project.clj`)
* -v --version Project version (if not given will be taken from `project.clj`)
* -D --desc Project description (if not given will be taken from `project.clj`)
* -a --deps Project dependencies in the form `::;...` (if not given will be taken from `project.clj`)
* -c --css Additional css resources `;;...` (if not given will be taken from `project.clj`)
* -j --js Additional javascript resources `;;...` (if not given will be taken from `project.clj`)
* -m --multi Generate each namespace documentation as a separate file
* -e --exclude Exclude source file(s) from the document generation process `;;...` (if not given will be taken from `project.clj`)
### Maven
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`.
```xml
org.cloudhoist.plugin
zi
0.5.0
autodoc/marginalia
```
And the following to the project's `settings.xml` file.
```xml
org.cloudhoist.plugin
clojure-dev
sonatype-snapshots
http://oss.sonatype.org/content/repositories/releases
clojure-dev
```
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.
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*
- [Fogus](http://fogus.me/fun/)
- [Zachary Kim](https://github.com/zk)
- [Justin Balthrop](https://github.com/ninjudd)
- [Brenton Ashworth](https://github.com/brentonashworth)
- [Nicolas Buduroi](https://github.com/budu)
- [Michael Harrison](https://github.com/goodmike)
- [Anthony Grimes](https://github.com/Raynes)
- [Sam Ritchie](https://github.com/sritchie)
- [Hugo Duncan](https://github.com/hugoduncan)
- [Vadim](https://github.com/dm3)
- [Meikel Brandmeyer](https://github.com/kotarak)
- [Paul Dorman](https://github.com/pauldorman)
- [Deepak Giridharagopal](https://github.com/grimradical)
- [Tero Parviainen](https://github.com/teropa)
- [MerelyAPseudonym](https://github.com/MerelyAPseudonym)
- [Ivan](https://github.com/ivantm)
- [Benjamin Bader](https://github.com/benjamin-bader)
- [Frederick Giasson](https://github.com/fgiasson)
- [Michael Bloom](https://github.com/MichaelBlume)
- [Tristan Strange](https://github.com/triss)
If I've missed your name then please ping me.
License
-------
Copyright (C) 2010-2017 Gary, Fogus and contributors.
Distributed under the Eclipse Public License, the same as Clojure.
近期下载者:
相关文件:
收藏者: