Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

13.0.0 (2024-03-17)

New Features

• add newlines_after_metadata option

Bug Fixes

• set correct yaml metablock end tag

Test

• add frontmatter snapshot

New Features (BREAKING)

• support for controlling the amount of newlines after metadata blocks.

Commit Statistics

• 5 commits contributed to the release.
• 4 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Support for controlling the amount of newlines after metadata blocks. (834c74b)
  • Refactor (b8ae359)
  • Add frontmatter snapshot (5d94036)
  • Add newlines_after_metadata option (8d39a30)
  • Set correct yaml metablock end tag (7b27baa)

12.0.0 (2024-03-16)

Other

• update pulldown-cmark dependency

New Features (BREAKING)

• upgrade to pulldown-cmark v0.10 This comes with a variety of changes to the State type, which is the reason this is a breaking release.

  The overall correctness is improved though, bringing the amount of successful tests of the spec to 435/649 (up by 4).

Commit Statistics

• 18 commits contributed to the release over the course of 34 calendar days.
• 48 days passed between releases.
• 2 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Release pulldown-cmark-to-cmark v12.0.0 (002be03)
  • Upgrade to pulldown-cmark v0.10 (640148b)
  • Avoid allocations (366f304)
  • Allow State to borrow from events (b3bfd40)
  • Remove State::last_was_html (42739b5)
  • Test custom attributes (8152f81)
  • Adjust snapshots (1c21b70)
  • Remove trailing whitespace in snapshots (seems to be a pulldown-cmark parsing change) (b09ce73)
  • Fix handling of HTML blocks (6afb4cd)
  • Clippy (4a66292)
  • Fix EndTag tests (38bb5dd)
  • Comment out end tag tests that aren't triviably updateable (82110a4)
  • Support heading attributes (fc30c6d)
  • Fix test (ea2608e)
  • Fix easily-updateable tests (ebf9b69)
  • Add link/image stacks and track current header (3090b8a)
  • Metadata blocks (a26731c)
  • Update pulldown-cmark dependency (b90defb)

11.2.0 (2024-01-27)

New Features

• introduce calculate_code_block_token_count(), along with DEFAULT_CODE_BLOCK_TOKEN_COUNT. That way it's possible to correctly determine the amount of fenced code-block tokens needed to render all given events such that code-blocks are retained.

Commit Statistics

• 4 commits contributed to the release.
• 1 day passed between releases.
• 1 commit was understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Release pulldown-cmark-to-cmark v11.2.0 (11344a7)
  • Merge branch ‘fix_count_code_block_tokens’ (ee42335)
  • Introduce calculate_code_block_token_count(), along with DEFAULT_CODE_BLOCK_TOKEN_COUNT. (e339365)
  • Change the return type of count_code_block_tokens (ef1c276)

11.1.0 (2024-01-25)

New Features

• add count_code_block_tokens() function. It allows to calculate the amount of backticks around a code block for given events to assure code-blocks are reproduced correctly when rendering the same events.

Commit Statistics

• 6 commits contributed to the release over the course of 59 calendar days.
• 61 days passed between releases.
• 1 commit was understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Release pulldown-cmark-to-cmark v11.1.0 (d236e29)
  • Add count_code_block_tokens() function. (10b855f)
  • Refactor (c0f631d)
  • Add check_code_block_token_count function (f119d77)
  • Merge pull request #64 from max-heller/readme-links (b926264)
  • Update pulldown-cmark and mdbook links in README (31e8bb5)

11.0.2 (2023-11-24)

Bug Fixes

• Escape double quotes in link titles.

Commit Statistics

• 5 commits contributed to the release.
• 4 days passed between releases.
• 1 commit was understood as conventional.
• 1 unique issue was worked on: #62

Commit Details

• #62
  • Escape double quotes in link titles. (9a64f6b)
• Uncategorized
  • Release pulldown-cmark-to-cmark v11.0.2 (befdaab)
  • Address code review comments (4767b2f)
  • Escape double quotes in link titles (74f0abe)
  • Failing test for link titles with interior punctuation (e891ea4)

11.0.1 (2023-11-19)

Fix

• properly format multi-line footnotes. Merge branch ‘multiline-footnotes’ (f6b5348)

Commit Statistics

• 5 commits contributed to the release.
• 92 days passed between releases.
• 0 commits were understood as conventional.
• 1 unique issue was worked on: #61

Commit Details

• #61
  • Fix: properly format multi-line footnotes. Merge branch ‘multiline-footnotes’ (f6b5348)
• Uncategorized
  • Release pulldown-cmark-to-cmark v11.0.1 (b1f77e0)
  • Prepare changelog (323cbc0)
  • Multiline footnote fix (4768ad5)
  • Failing multiline footnote test (e187313)

11.0.0 (2023-08-18)

New Features

• add apache-2 license text to crate as well

Bug Fixes

• improve handling of inline code spans with multiple backticks Merge pull request #56 from mgeisler/inline-code

New Features (BREAKING)

• Options to choose the ordered list marker and to auto-increment the ordered list numbers.
  • Based on the commonmark list spec an ordered list can use . or ) as the ordered list marker. Now users can configure the marker they want to use with the ordered_list_token option.

Commit Statistics

• 14 commits contributed to the release over the course of 232 calendar days.
• 342 days passed between releases.
• 3 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Thanks Clippy

Clippy helped 2 times to make code idiomatic.

Commit Details

• Uncategorized
  • Release pulldown-cmark-to-cmark v11.0.0 (6f23621)
  • Merge branch ‘lic’ (b889953)
  • Add apache-2 license text to crate as well (d9eb454)
  • Add license text (9ea32f4)
  • Improve handling of inline code spans with multiple backticks (c2a0113)
  • Refactor (1cd68a4)
  • Thanks clippy (8f81a30)
  • Use necessary amount of backticks for inline code (3437734)
  • Always use backticks for inline code blocks (1e76c95)
  • Options to choose the ordered list marker and to auto-increment the ordered list numbers. (2263c2f)
  • Thanks clippy (6bde374)
  • Correct indentation for a nested list in a doc comment (ce1fb72)
  • Add option to increment ordered list number (f2fae4b)
  • Allow users to specify a custom ordered list marker (981c86a)

10.0.4 (2022-09-10)

Bug Fixes

• add newlines where needed to produce valid codeblocks

Commit Statistics

• 6 commits contributed to the release over the course of 1 calendar day.
• 1 day passed between releases.
• 1 commit was understood as conventional.
• 1 unique issue was worked on: #48

Commit Details

• #48
  • Add newlines where needed to produce valid codeblocks (f3b4370)
• Uncategorized
  • Release pulldown-cmark-to-cmark v10.0.4 (5f6ec45)
  • Cargo fmt (89b557a)
  • Fix typo (1833cfb)
  • Inserts a newline if there is no newline before code block termination fence (ef4c401)
  • Add a test case to verify that indented code blocks without trailing \n are rendered correctly (6c6f492)

10.0.3 (2022-09-09)

Bug Fixes

• duplicated shortcut link definitions are only printed once.

Other

• Replace .travis.yml with .github/workflows/rust.yml We have already migrated from Travis CI to GitHub Actions.

Commit Statistics

• 5 commits contributed to the release.
• 73 days passed between releases.
• 2 commits were understood as conventional.
• 1 unique issue was worked on: #46

Commit Details

• #46
  • Duplicated shortcut link definitions are only printed once. (ff4050f)
• Uncategorized
  • Release pulldown-cmark-to-cmark v10.0.3 (4e7c91b)
  • De-duplicate shortcut link definitions (32d9466)
  • Add a test case to verify that repeated reference links are rendered correctly (eb6ab63)
  • Replace .travis.yml with .github/workflows/rust.yml (e214cc1)

10.0.2 (2022-06-28)

Fixes

• support for backticks within inline-backticks, see this this comment for details.

Commit Statistics

• 4 commits contributed to the release over the course of 2 calendar days.
• 108 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Release pulldown-cmark-to-cmark v10.0.2 (341f46e)
  • Update changelog (0fa8688)
  • Add space aroudn backticks (6f68331)
  • Fix double-backtick issue (09a35a9)

10.0.1 (2022-03-12)

Fixes

• add cmark_resume(), completing the API transition started with the major version change.

Commit Statistics

• 6 commits contributed to the release.
• 42 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Release pulldown-cmark-to-cmark v10.0.1 (d2d1e6e)
  • Update changelog (eb88b2e)
  • Add clippy to Makefile/CI (7bb9a68)
  • Fix misc Clippy lints (118df17)
  • Re-order to logically group cmark* functions (16f06eb)
  • Add cmark_with_options() and fix comments (53efeb8)

10.0.0 (2022-01-28)

Note that the breaking change is fixable by removing the last parameter from the cmark() function if it was None, or using cmark_resume instead.

New Features

• Formatting within links is no being preserved.

New Features (BREAKING)

• Simplify cmark(…) by removing State parameter, introduce cmark_resume(…).

  The reason for doing it this way around causing a breaking change is the change of behaviour for cmark_resume, which now returns a state instance that needs a finalize() call to flush certain caches.

  Currently this is only used to write link blocks, after which the state is still usable for future invocations if necessary.

  That way the caller has control over where to put link blocks, or other items that should be placed at the end of a logical section.

Commit Statistics

• 6 commits contributed to the release over the course of 28 calendar days.
• 28 days passed between releases.
• 1 commit was understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Release pulldown-cmark-to-cmark v10.0.0 (44c5286)
  • Write changelog prior to release (e9f809f)
  • Merge pull request #41 from aogier/bugfix/40-shortcut_code (7ee11da)
  • Simplify cmark(…) by removing State parameter, introduce cmark_resume(…). (7166abe)
  • Properly render shortcut links w/ code formatting (6a42312)
  • Fix changelog (84acaf3)

9.0.0 (2021-12-31)

Bug Fixes

• Shortcut handling is now using the State.

  This makes resumable event processing work as expected, even though the output won‘t be similar as it will print shortcuts right after all events have been processed and it’s impossible to know how often it will be called.

• Simplify State.

  Use an Option to get rid ofa boolean and make isuse impossible.

Commit Statistics

• 6 commits contributed to the release.
• 5 days passed between releases.
• 2 commits were understood as conventional.
• 1 unique issue was worked on: #39

Commit Details

• #39
  • Shortcut handling is now using the State (0a6f80d)
• Uncategorized
  • Release pulldown-cmark-to-cmark v9.0.0 (c14d084)
  • Write changelog (ddff119)
  • Simplify State (93f2d11)
  • Refactor (c0f14c0)
  • Refactor (9283d48)

8.0.0 (2021-12-26)

This release adds support for pulldown-cmark v0.9, see the tracking issue for more information.

Commit Statistics

• 4 commits contributed to the release.
• 20 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Release pulldown-cmark-to-cmark v8.0.0 (cf469e2)
  • Adjust changelog prior to release (0ed0c69)
  • Cargo fmt (c696de3)
  • Support the new Heading tag in pulldown-cmark 0.9 (1c9ea44)

7.1.1 (2021-12-05)

Fixes

• Multiple shortcut links are now separated by newline.

Commit Statistics

• 3 commits contributed to the release.
• 10 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Release pulldown-cmark-to-cmark v7.1.1 (e95115e)
  • Update changelog prior to patch release (e540024)
  • Fix shortcuts rendering (3bbc763)

7.1.0 (2021-11-25)

New Features

• Shortcut links are now printed at the end of the stream like one would expect (#33)
• email links are retained (#34)
• Now 422 of 649 common mark spec tests pass, up from 402.

Commit Statistics

• 6 commits contributed to the release.
• 7 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Release pulldown-cmark-to-cmark v7.1.0 (68a9b6a)
  • Update changelog (bbc22fe)
  • Use match as expression (2d5d4e1)
  • Merge branch ‘feature/32-shortcut-links’ of https://github.com/aogier/pulldown-cmark-to-cmark into aogier-feature/32-shortcut-links (81b1eb4)
  • Retain autolink/email link format (e25f14d)
  • Shortcut links implementation (25cc3d1)

7.0.0 (2021-11-17)

The Options type was updated in a breaking fashion to allow configuring certain tokens, e.g. the * list token can now be configured as - if desired.

Thanks to the author of this PR.

Commit Statistics

• 7 commits contributed to the release over the course of 53 calendar days.
• 53 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Release pulldown-cmark-to-cmark v7.0.0 (cc82b0f)
  • Update changelog prior to release (0b795a7)
  • Refactor (06fe6cb)
  • More efficient handling of reconfigured characters (fa14750)
  • Cleanup typing for special characters (9aef43f)
  • Change options to support custom syntax and add test (db6e12c)
  • Format with nightly (9313bac)

v6.0.4 (2021-09-25)

• Improves newline handling when line ends with inline HTML

Commit Statistics

• 3 commits contributed to the release.
• 17 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Release pulldown-cmark-to-cmark v6.0.4 (72e5ca5)
  • Prepare changelog (50b4188)
  • Don't output extra newlines after HTML before a SoftBreak (1a40792)

v6.0.3 (2021-09-07)

• handle spaces in links better

Commit Statistics

• 3 commits contributed to the release.
• 75 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Release pulldown-cmark-to-cmark v6.0.3 (100c41a)
  • Prepare release (b3015aa)
  • Handle spaces in link URIs (9f8f17b)

v6.0.2 (2021-06-23)

Commit Statistics

• 4 commits contributed to the release.
• 19 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • (cargo-release) version 6.0.2 (c1cd8ce)
  • Prepare patch release (1872953)
  • Adjust test expecations - it's probably more correct now (6bc1f11)
  • Don‘t add a newline after an HTML block if we’re just ending another tag (89cc1ec)

v6.0.1 (2021-06-04)

• handline html in tables correctly.

Commit Statistics

• 14 commits contributed to the release over the course of 133 calendar days.
• 233 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Thanks Clippy

Clippy helped 1 time to make code idiomatic.

Commit Details

• Uncategorized
  • (cargo-release) version 6.0.1 (7782189)
  • Adjust test expectations - it's OK to degenerate information I suppose (f733496)
  • Prepare release (874edba)
  • Also escape closing brackets (oversight); fixes #25 (7fdf0da)
  • Merge remote-tracking branch ‘origin/main’ into crlf0710/main (934cfab)
  • Allow the commonmark-spec test to fail right now… (65f5949)
  • Re-enable test-suite :D (c2a2de3)
  • Add a test that verify current implementation against all the examples from CommonMark spec. (f27acce)
  • Dependency update (59db24f)
  • Use make in CI (4b53d20)
  • Use modern doc string type links (cac031a)
  • Thanks clippy (16e66da)
  • Cargo fmt (9d2dc90)
  • Add makefile for convenience (45bfb5e)

v6.0.1 (2021-06-04)

• also escape ‘]’ characters

v6.0.0 (2020-10-13)

Commit Statistics

• 2 commits contributed to the release over the course of 42 calendar days.
• 72 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Bump pulldown-cmark (3ae8ddc)
  • Update dependencies (ba51fda)

v5.0.0 (2020-08-02)

• Allow configuring the amount of backticks used in code blocks. May break code relying on the amount of fields in the configuration struct.

Commit Statistics

• 3 commits contributed to the release.
• 58 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • (cargo-release) version 5.0.0 (a5f644a)
  • Update changelog (5f7be5e)
  • Make the number of backticks in codeblocks configurable (c9267b5)

v4.0.2 (2020-06-05)

• Fixed table header handling (see PR for details)

Commit Statistics

• 4 commits contributed to the release over the course of 9 calendar days.
• 20 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Bump patch level (1240a59)
  • Avoid integer underflow (8774c43)
  • Capture inline-code as table header (025d8c2)
  • Run cargo diet (8618b3d)

v4.0.1 (2020-05-15)

Commit Statistics

• 2 commits contributed to the release.
• 23 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Bump patch level (03f4ab8)
  • Add a newline before code blocks if necessary (061f7b8)

v4.0.0 (2020-04-22)

• BREAKING: Move all types from pulldown_cmark_to_cmark::fmt::* into pulldown_cmark_to_cmark::* for simplicity. For most common use-cases, this means that users of pulldown_cmark_to_cmark::fmt::cmark now use pulldown_cmark_to_cmark::cmark instead.

Commit Statistics

• 1 commit contributed to the release.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Simplify library layout: move fmt::* into crate root (7070f33)

v3.0.1 (2020-04-22)

• support for markdown embedded in HTML tags, like

  <article>
  
    * list
    * list
  
    **bold**
  
  </article>
  

Commit Statistics

• 10 commits contributed to the release over the course of 15 calendar days.
• 81 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Bump patch level; add changelog (b53fbe5)
  • Use Rust Edition 2018 QoL improvements (0b414d0)
  • Move last_was_html into state definition (allowing resumes) (59c5a3b)
  • Add newlines after HTML elemets if followed by more markdown (fcd32d0)
  • Bye bye travis, we had a good time (2ea28f7)
  • Add github actions (6b3f51c)
  • Update minor version of pulldown-cmark (3e856c9)
  • Update tests to use new code block kind (5b1c7c6)
  • Expose pulldown_cmark dependency to users (0174671)
  • Upgrade cmark dependency and handle new code block (5786f7e)

v2.0.1 (2020-01-31)

Commit Statistics

• 2 commits contributed to the release.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Bump patch (63ac5ca)
  • Dumber, byte oriented escape code (b3dce1a)

v2.0.0 (2020-01-31)

Commit Statistics

• 8 commits contributed to the release.
• 60 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Upgrade to edition 2018 (c6fb144)
  • Optimize release (17e9f4e)
  • Add real-world tests, related to #8 (8d7378f)
  • Add support for escapes, fixes #8 (91df9a2)
  • Run cargo fmt (d68f033)
  • Bump our version to 2.0 (d64853c)
  • Fix inline-html output (63f4e4f)
  • Update to pulldown-cmark 0.6.1 (4900624)

v1.2.4 (2019-12-02)

Commit Statistics

• 5 commits contributed to the release over the course of 7 calendar days.
• 34 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Bump version to 1.2.4 (ebd8e8e)
  • Merge pull request #7 from dylanowen/blockquotes (fee9004)
  • Updated authors (58e5137)
  • Better support for blockquotes (6f0e4b5)
  • Added blockquote test cases (2dd8024)

v1.2.3 (2019-10-28)

Commit Statistics

• 3 commits contributed to the release.
• 117 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Bump version (6f2382e)
  • Better approximation of contained characters (83fdbc0)
  • Assure to never have truly empty header fields (00442f9)

v1.2.2 (2019-07-03)

Commit Statistics

• 2 commits contributed to the release.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Minor version bump (83c6edc)
  • Upgrade to pulldown-cmark 0.5.2; with clear regressions (c8e2b9b)

v1.2.1 (2019-07-03)

Commit Statistics

• 6 commits contributed to the release over the course of 73 calendar days.
• 194 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Upgrade to pulldown-cmark 0.4 (27909e0)
  • Merge pull request #3 from integer32llc/pulldown-cmark-0.4 (a92f729)
  • Add a test that generated markdown parses equivalently (90f134e)
  • Update table snapshot to remove whitespace in table cells (148c789)
  • Remove trailing spaces from the table test fixture (c6490bc)
  • Upgrade to pulldown-cmark 0.4.1 (9a87b4e)

v1.2.0 (2018-12-20)

Commit Statistics

• 4 commits contributed to the release over the course of 299 calendar days.
• 309 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Bump version after supporting the latest pulldown-cmark 0.2 (108c355)
  • Merge pull request #1 from maralorn/master (7a4f8a5)
  • Bump dependency versions (5c7ddd5)
  • Add crates badge (b3ec0d9)

v1.1.0 (2018-02-13)

Commit Statistics

• 5 commits contributed to the release over the course of 1 calendar day.
• 2 days passed between releases.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Bump minor (ba3d313)
  • Support for codeblocks in codeblocks (a594c33)
  • Add example for codeblock in codeblock (fa9d980)
  • Some more infos for the README (9705eb8)
  • Add depndency info badge (1869129)

v1.0.0 (2018-02-11)

Commit Statistics

• 6 commits contributed to the release.
• 0 commits were understood as conventional.
• 0 issues like ‘(#ID)’ were seen in commit messages

Commit Details

• Uncategorized
  • Add tests-title (34598b8)
  • Add project affiliations (55a5563)
  • First bunch of API docs (f315ab7)
  • Update all links (b1e0978)
  • First minor adjustment before all links change. (5b4c1ef)
  • Move everything from ‘termbook’. (7666772)