@@ -57,18 +57,21 @@ And invoke it with `clojure -M:marginalia`. Without the alias, you could use `cl
57
57
58
58
Marginalia accepts options as described below:
59
59
60
- | Flag | | Default | Description |
61
- | ---- | --------- | -------------------- | ----------------------------------------------------------------------------------|
62
- | -d | --dir | ` docs ` | Directory into which the documentation will be written |
63
- | -f | --file | ` uberdoc.html ` | File into which the documentation will be written |
64
- | -n | --name | (from ` project.clj ` ) | Project name |
65
- | -v | --version | (from ` project.clj ` ) | Project version |
66
- | -D | --desc | (from ` project.clj ` ) | Project description |
67
- | -a | --deps | (from ` project.clj ` ) | Project dependencies in the form ` <group1>:<artifact1>:<version1>;<group2>... ` |
68
- | -c | --css | (from ` project.clj ` ) | Additional css resources ` <resource1>;<resource2>;... ` |
69
- | -j | --js | (from ` project.clj ` ) | Additional javascript resources ` <jsfile1>;<jsfile2>;... ` |
70
- | -m | --multi | disabled | Generate each namespace documentation as a separate file |
71
- | -e | --exclude | (from ` project.clj ` ) | Exclude source file(s) from the document generation process ` <file1>;<file2>;... ` |
60
+ | Flag | | Default | Description |
61
+ | ---- | ----------- | ---------------------- | ----------------------------------------------------------------------------------|
62
+ | -d | --dir | ` ./docs ` | Directory into which the documentation will be written |
63
+ | -f | --file | ` uberdoc.html ` | File into which the documentation will be written |
64
+ | -n | --name | (from ` project.clj ` ) | Project name |
65
+ | -v | --version | (from ` project.clj ` ) | Project version |
66
+ | -D | --desc | (from ` project.clj ` ) | Project description |
67
+ | -a | --deps | (from ` project.clj ` ) | Project dependencies in the form ` <group1>:<artifact1>:<version1>;<group2>... ` |
68
+ | -c | --css | (from ` project.clj ` ) | Additional css resources ` <resource1>;<resource2>;... ` |
69
+ | -j | --js | (from ` project.clj ` ) | Additional javascript resources ` <jsfile1>;<jsfile2>;... ` |
70
+ | -m | --multi | disabled | Generate each namespace documentation as a separate file |
71
+ | -e | --exclude | (from ` project.clj ` ) | Exclude source file(s) from the document generation process ` <file1>;<file2>;... ` |
72
+ | -l | --leiningen | | Generate the documentation for a Leiningen project file |
73
+ | -L | --lift-in-line-comments | disabled | Lift ;; inline comments to the top of the enclosing form. |
74
+ | -X | --exclude-lifted-comments | disabled | If inline comments are being lifted, then also exclude them from the source code display |
72
75
73
76
### Maven
74
77
0 commit comments