Skip to content

Commit 58b257b

Browse files
committed
update own docs
1 parent b290f60 commit 58b257b

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

API.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
# Table of contents
2-
- [`quickdoc.api`](#quickdocapi) - API namespace for quickdoc.
3-
- [`quickdoc`](#quickdoc) - Generate API docs.
4-
# quickdoc.api
2+
- [`quickdoc.api`](#quickdoc.api) - API namespace for quickdoc.
3+
- [`quickdoc`](#quickdoc.api/quickdoc) - Generate API docs.
4+
5+
-----
6+
# <a name="quickdoc.api">quickdoc.api</a>
57

68

79
API namespace for quickdoc.
810

911

1012

11-
## `quickdoc`
13+
14+
## <a name="quickdoc.api/quickdoc">`quickdoc`</a> [:page_facing_up:](https://github.com/borkdude/quickdoc/blob/main/src/quickdoc/api.cljc#L17-L76)
15+
<a name="quickdoc.api/quickdoc"></a>
1216
``` clojure
1317

14-
(quickdoc
15-
{:keys [github/repo git/branch outfile source-paths toc var-links overrides],
16-
:or {branch "main", outfile "API.md", source-paths ["src"], toc true, var-links true},
17-
:as opts})
18+
(quickdoc opts)
1819
```
1920

2021

@@ -26,7 +27,7 @@ Generate API docs. Options:
2627
* `:source-paths` - sources that are scanned for vars. Defaults to `["src"]`.
2728
* `:toc` - generate table of contents. Defaults to `true`.
2829
* `:var-links` - generate links to vars within the same namespace. Defauls to `true`.
30+
* `:var-pattern` - detecting vars for linking, either `:backticks` (default) or `:wikilinks` (double brackets)
2931
* `:overrides` - overrides in the form `{namespace {:no-doc true var {:no-doc true :doc ...}}}`.
3032

3133
Returns a map containing the generated markdown string under the key `:markdown`.
32-
<br><sub>[source](https://github.com/borkdude/quickdoc/blob/main/src/quickdoc/api.cljc#L18-L87)</sub>

0 commit comments

Comments
 (0)