Commit graph

284 commits

Author SHA1 Message Date
Gary Deer
2fec577a3d updated readme 2015-08-21 23:23:53 -05:00
Gary Deer
f1821afd5a added badge to readme 2015-08-21 23:21:29 -05:00
Ben Bader
5b12600546 Merge pull request #154 from MichaelBlume/handle-args
handle (ignore) extra args from LispReader
2015-07-19 17:00:54 -07:00
Mike Blume
1abd12a9e8 handle (ignore) extra args from LispReader
with the new reader conditionals patch, readers are passed additional
arguments.

Ignore them.

Fixes #153
2015-05-03 12:24:37 -07:00
Ben Bader
a34b1c6606 Merge pull request #138 from fgiasson/master
Add a new option to exclude source files from being processed by Margina...
2015-01-25 15:34:59 -08:00
Frederick Giasson
eb8808706a Merge remote-tracking branch 'upstream/master'
Conflicts:
	README.md
2015-01-16 14:32:20 -05:00
Frederick Giasson
a97efcc5f5 Fixed documentation to make it consistent 2015-01-16 14:26:16 -05:00
Ben Bader
715e4f14f0 Merge pull request #140 from dtulig/master
Addresses an issue where marginalia fails to parse a project.clj where the first form in the file isn't "defproject".
2015-01-08 12:23:22 -08:00
Ben Bader
ab71d7d4d1 Merge pull request #141 from bilus/cljx-reader-macros
Add support for cljx reader tags #+clj and #+cljs
2015-01-08 12:19:35 -08:00
Ben Bader
45cf608e6f Update copyright and fix broken contributor link 2015-01-07 10:52:00 -08:00
Ben Bader
f7bd09f1be Merge pull request #142 from harrigan/fix-typos
Fix typos
2015-01-07 10:28:58 -08:00
Martin Harrigan
e7806a7a45 Fix typos 2015-01-07 15:07:20 +00:00
Martin Bilski
e35c3baeff Fix no newline at the end of parser.clj. 2015-01-06 22:25:40 +01:00
Martin Bilski
319f26693d Fix no namespace extracted from .cljx files. 2015-01-06 22:22:10 +01:00
Martin Bilski
0e43f515a9 Add support for cljx reader tags #+clj and #+cljs to make it possible to generate marginalia docs in projects using cljx to target Clojure and ClojureScript. 2015-01-06 15:43:13 +01:00
David Tulig
1dbbd42862 Addresses an issue where marginalia fails to parse a project.clj where
the first form in the file isn't "defproject".

Instead of reading just the first line, parse-project-form will loop
through the full file, stopping when defproject is found and then
parse it as it always has.
2014-12-27 14:41:34 -06:00
Frederick Giasson
fbb81f04d6 Update documentation such that we make clear that the MathJax CDN can be the value of the :javascript key. That way, users don't have to download, install, deploy and carry arround MathJax. 2014-12-18 13:33:48 -05:00
Frederick Giasson
c60d731066 Add a new option to exclude source files from being processed by Marginalia.
The new option is available at the command line with "-e" or "--exclude". It can also be part of the project.clj file via the ":exclude" keyword.

I was requiring this feature because I often have local testing files which I don't want to be included in the documentation.

The new option is quite simple: it simply filter out the files that have been identified by the option out of the "sources" var before it is being used by multidoc! or uberdoc!
2014-12-18 09:35:33 -05:00
Ben Bader
a21cd992c4 Merge pull request #134 from fogus/master
Added support for prasing Lein project.clj files and files without ns decls
2014-11-28 22:06:51 -08:00
fogus
9e66b1266d Removed the default 2014-11-18 14:10:35 -05:00
fogus
8522fa3fba Removed the default 2014-11-18 14:08:47 -05:00
fogus
e512fec93c The filename itself can standin for the namespace when its has none (e.g. project.clj and data_readers.clj) 2014-11-18 13:18:17 -05:00
fogus
0bd050d75a First cut at parsing the project.clj file too. 2014-11-18 12:43:18 -05:00
Gary Deer
e54a83a28b can't cut a release without release notes 2014-09-04 20:43:06 -05:00
Gary Deer
1afa0d034b Update README.md 2014-09-04 09:56:50 -05:00
Gary Deer
fd7168219a Delete project.clj~ 2014-08-28 21:52:17 -05:00
Gary Deer
1e234949d4 Delete README.md~ 2014-08-28 21:52:01 -05:00
Gary Deer
a30ee8c2bd updated release version 2014-08-28 21:47:01 -05:00
Gary Deer
445dd05319 Merge pull request #130 from OtherPeoplesPixels/master
Improve cljs file support and sort by namespace
2014-03-15 13:13:38 -05:00
Kevin Neaton
da5bf8d3fa Sort files by namespace :) 2014-03-13 14:59:18 -05:00
Kevin Neaton
275b470eec Improved handling of clojurescrpt files...
* Find all processable files in one pass to preserve order.
* Added .cljx to the set of processable file extensions.
* Use set as predicate instead of regex. Maybe down the road this set
  could be configured by users in their project.clj files?
2014-03-13 14:54:29 -05:00
Kevin Neaton
56a9e6a004 Updated styles to ensure that h2 and h3 are smaller than h1 2014-03-13 14:48:47 -05:00
benjamin-bader
9ba5c6ccc7 Merge pull request #129 from benjamin-bader/fix-github-url
Fixing Marginalia's GitHub URL in the source code.
2014-02-28 19:42:46 -08:00
Ben Bader
1eca1651a5 Fixing Marginalia's GitHub URL in the source code. 2014-02-28 19:40:09 -08:00
Gary Deer
91ba89b950 Merge pull request #127 from benjamin-bader/fix-floating-toc
Actually inserting floating-toc HTML into generated uberdoc.
2014-02-27 18:45:03 -06:00
Ben Bader
4c561a524a Actually inserting floating-toc HTML into generated uberdoc.
The var itself was being written out, not its contents.  On top of that,
the var holds a fn, and not HTML.  This patch invokes the fn where
appropriate (i.e. in `uberdoc-html`).
2014-02-26 10:17:13 -08:00
Gary Deer
2d8bfb72ee updated readme 2014-02-21 19:10:48 -06:00
Gary Deer
13612a3c7b Merge pull request #126 from benjamin-bader/add-comment-directives
Adding directives to selectively disable comment parsing.
2014-02-21 19:01:00 -06:00
Ben Bader
28eff57a69 Replacing "#" with "@" as the directive-start character.
In the excitement of getting something working and polished, I
overlooked the fact that "#" is indeed part of Markdown syntax, and that
there is little to distinguish `;; #Directive` from `;; # Title`.

"@" is visually distinctive, and is not currently part of Markdown.
2014-02-16 15:57:54 -08:00
Ben Bader
7e1eee7ff7 Adding directives to selectively disable comment parsing.
This change adds so-called 'directives' to our comments.  A directive is
a comment line whose only contents are a hash, followed by the directive
name, e.g.

```
;; #DirectiveName
```

Directives are not included in the `*comments*` vector in any case.

The two directives implemented here are "#MargDisable" and
"#MargEnable".  The former, when encountered, causes comments read by
`read-comment` to be ignored.  The latter re-enables it.

The rationale for this change is to accommodate e.g. license-header
boilerplate without polluting the generated docs.
2014-02-16 13:57:42 -08:00
Murphy McMahon
17c75832de add cljs data literal support to parse-file 2014-01-01 18:53:53 -02:00
Murphy McMahon
cdbc6e6dc8 ignore nrepl 2013-12-30 23:46:12 -02:00
Gary D
8fc18a22af More README fixes, all links should be correct now 2013-10-13 13:16:27 -05:00
Gary Deer
78863a2812 Merge pull request #117 from vedang/patch/link-url
Hyperlink the project name to it's URL.
2013-10-13 10:37:31 -07:00
Gary Deer
19dd1cd1db Merge pull request #118 from rmacy/patch-1
Update README.md
2013-10-13 10:27:37 -07:00
Ryan Macy
85d6e21319 Update README.md
Fix broken URL
2013-09-18 03:54:58 -05:00
Vedang Manerikar
43e855a1f1 Hyperlink the project name to it's URL.
If :url is provided in the project-info, use it to create a hyperlink
for the project-name
2013-09-13 13:08:55 +05:30
Gary Deer
5e1dc99f9c took down the "help wanted" sign and put up the "under new management" sign 2013-08-13 07:56:51 -05:00
Fogus
a36b938266 Update README.md 2013-08-07 09:07:31 -04:00
Fogus
0b263c0ffe Merge pull request #115 from alexander-yakushev/master
Treat single semicolons on the line as single comments
2013-08-07 05:49:04 -07:00