Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Aug 22, 2022
1 parent 5120b3f commit cb070f6
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,22 +65,22 @@ CL-USER> (common-doc.format:emit-to-string

<a id="x-28COMMONDOC-MARKDOWN-2FEMITTER-3A-2AGENERATE-SHORT-LINK-REFERENCES-2A-20-28VARIABLE-29-29"></a>

### [variable](7de3) `commondoc-markdown/emitter:*generate-short-link-references*` t
### [variable](ad9f) `commondoc-markdown/emitter:*generate-short-link-references*` t

By default it is `T`, but you can bind it to `NIL`,
to prevent short link references generation.

<a id="x-28COMMONDOC-MARKDOWN-2FEMITTER-3A-2AMIN-LINK-HASH-LENGTH-2A-20-28VARIABLE-29-29"></a>

### [variable](2c5a) `commondoc-markdown/emitter:*min-link-hash-length*` 4
### [variable](0f3e) `commondoc-markdown/emitter:*min-link-hash-length*` 4

Minumum length of the hash for generated markdown links.
This works only when [`*generate-short-link-references*`][651c] variable
is set to `T`.

<a id="x-28COMMONDOC-MARKDOWN-2FEMITTER-3A-2AEMIT-SECTION-ANCHORS-2A-20-28VARIABLE-29-29"></a>

### [variable](35db) `commondoc-markdown/emitter:*emit-section-anchors*` t
### [variable](7f10) `commondoc-markdown/emitter:*emit-section-anchors*` t

When this variable is `T` (default), emitter outputs
a raw html `<a name="some-id"></a>` before each
Expand All @@ -98,9 +98,9 @@ Markdown section.
[778d]: https://40ants.com/doc/
[4117]: https://commonmark.org/
[95d0]: https://github.com/3b/3bmd
[35db]: https://github.com/40ants/commondoc-markdown/blob/d17cc3b28e4eb3ebae3721807cff0c516fba409c/src/emitter.lisp#L21
[7de3]: https://github.com/40ants/commondoc-markdown/blob/d17cc3b28e4eb3ebae3721807cff0c516fba409c/src/emitter.lisp#L26
[2c5a]: https://github.com/40ants/commondoc-markdown/blob/d17cc3b28e4eb3ebae3721807cff0c516fba409c/src/emitter.lisp#L93
[7f10]: https://github.com/40ants/commondoc-markdown/blob/5120b3f23613cc4d06380a21ab48cf516fe862a7/src/emitter.lisp#L21
[ad9f]: https://github.com/40ants/commondoc-markdown/blob/5120b3f23613cc4d06380a21ab48cf516fe862a7/src/emitter.lisp#L26
[0f3e]: https://github.com/40ants/commondoc-markdown/blob/5120b3f23613cc4d06380a21ab48cf516fe862a7/src/emitter.lisp#L93

* * *
###### [generated by [40ANTS-DOC](https://40ants.com/doc/)]

0 comments on commit cb070f6

Please sign in to comment.