Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Oct 30, 2023
1 parent 9d31498 commit 7dfea7f
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
8 changes: 7 additions & 1 deletion ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

# ChangeLog

<a id="x-28COMMONDOC-MARKDOWN-DOCS-2FCHANGELOG-3A-3A-7C0-2E4-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.4.0 (2023-10-30)

* Fixed work with latest 3bmd Markdown parser.
* Fixed the way how bullet lists are rendered into Markdown. Now there is no blank lines between list items.

<a id="x-28COMMONDOC-MARKDOWN-DOCS-2FCHANGELOG-3A-3A-7C0-2E3-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.3.0 (2022-03-10)
Expand All @@ -16,7 +23,6 @@ when you enter `--text surrounded by two minus signs--`.
* Variable [`commondoc-markdown/emitter:*generate-short-link-references*`][651c]
was introduced. By default it is `T`, but you can bind it to `NIL`,
to prevent short link references generation.

* `HASH-LINK` function now is not exported from emitter package.

<a id="x-28COMMONDOC-MARKDOWN-DOCS-2FCHANGELOG-3A-3A-7C0-2E1-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,22 +64,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](764b) `commondoc-markdown/emitter:*generate-short-link-references*` t
### [variable](520e) `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](0e84) `commondoc-markdown/emitter:*min-link-hash-length*` 4
### [variable](1685) `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](d3c5) `commondoc-markdown/emitter:*emit-section-anchors*` t
### [variable](af50) `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 @@ -97,9 +97,9 @@ Markdown section.
[778d]: https://40ants.com/doc/
[4117]: https://commonmark.org/
[95d0]: https://github.com/3b/3bmd
[d3c5]: https://github.com/40ants/commondoc-markdown/blob/f501b41a930e8012556b9a9a739eec81187a5097/src/emitter.lisp#L21
[764b]: https://github.com/40ants/commondoc-markdown/blob/f501b41a930e8012556b9a9a739eec81187a5097/src/emitter.lisp#L26
[0e84]: https://github.com/40ants/commondoc-markdown/blob/f501b41a930e8012556b9a9a739eec81187a5097/src/emitter.lisp#L93
[af50]: https://github.com/40ants/commondoc-markdown/blob/9d314986b3ac037810f9bf4d2d7cde8f848b9ae1/src/emitter.lisp#L22
[520e]: https://github.com/40ants/commondoc-markdown/blob/9d314986b3ac037810f9bf4d2d7cde8f848b9ae1/src/emitter.lisp#L27
[1685]: https://github.com/40ants/commondoc-markdown/blob/9d314986b3ac037810f9bf4d2d7cde8f848b9ae1/src/emitter.lisp#L94

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

0 comments on commit 7dfea7f

Please sign in to comment.