comrak

• Restore inline sourcepos as experimental. by @kivikakk in https://github.com/kivikakk/comrak/pull/444
  • This is needed by some downstream users, so we re-introduce it, with a clearly labelled option.

Diff: https://github.com/kivikakk/comrak/compare/v0.25.0...v0.26.0

• Discord-flavored Markdown by @liamwhite in https://github.com/kivikakk/comrak/pull/421
  • Three new extensions and two render options are added:
    • extension.underline adds support for __underlined__ text.
    • extension.spoiler adds support for ||spoiler|| text.
    • extension.greentext adds support for image board-style >greentext, which isn't transformed into a blockquote.
    • render.ignore_setext disables parsing setext-style headings.
    • render.ignore_empty_links causes links with no text (like [](xyz)) to remain in the text as-is.
• nodes: add From impls for AstNode. by @kivikakk in https://github.com/kivikakk/comrak/pull/424
  • Back by popular demand: AstNode::from(NodeValue).
  • Also added is AstNode::from(Ast), if you have sourcepos.
• AST validation by @yannham in https://github.com/kivikakk/comrak/pull/425
  • The AST is validated when formatting a document as CommonMark in debug builds.
• Address autolink edge cases. by @kivikakk in https://github.com/kivikakk/comrak/pull/426
  • Autolinks had many edge cases where output differed from upstream cmark-gfm. These have been fixed by following upstream's parser design closely.
• shortcodes: capture all known aliases. by @kivikakk in https://github.com/kivikakk/comrak/pull/427
  • We didn't parse shortcodes containing numbers or +. We do now.
• Support both upstream CommonMark and GFM's differences in the base spec. by @kivikakk in https://github.com/kivikakk/comrak/pull/428
  • GFM modifies even base CommonMark output somewhat. We now support and validate against both.
• cm: count ol items from start of each list. by @kivikakk in https://github.com/kivikakk/comrak/pull/429
  • Ordered list item numbers are normalised on formatting back to CommonMark.
• arena_tree: panic if iterator invalidation causes trouble. by @kivikakk in https://github.com/kivikakk/comrak/pull/437
  • arena_tree would silently stop iteration when trying to proceed from a child that had lost its parent. It now panics instead, as the old behaviour is incorrect and impossible to notice.
• broken reflink callback updates & big cleanup. by @kivikakk in https://github.com/kivikakk/comrak/pull/438
  • The broken reference link callback has been moved into ParseOptions (which now takes a lifetime, meaning Options does too).
  • The callback now takes a struct containing both the normalised reference, and the original text, and the return value has changed from a 2-tuple to a struct for clarity.
  • parse_document_with_broken_link_callback has been marked deprecated.
• Inline sourcepos fixes. by @kivikakk in https://github.com/kivikakk/comrak/pull/439
  • Inline sourcepos was provided on a best-effort basis, but there are multiple correctness issues which can't be fixed without significant work.
  • Inline sourcepos is no longer reported in HTML output. It remains in the AST and in XML output, but it is not reliable. See the PR for details.
  • Link sourcepos is slightly better than it was when it spans multiple lines.

New Contributors

• @liamwhite made their first contribution in https://github.com/kivikakk/comrak/pull/421
• @yannham made their first contribution in https://github.com/kivikakk/comrak/pull/425

Diff: https://github.com/kivikakk/comrak/compare/v0.24.1...v0.25.0

What's Changed

• Add GH_TOKEN to release workflow by @digitalmoksha in https://github.com/kivikakk/comrak/pull/418
• [skip test] Release v0.24.1 by @github-actions in https://github.com/kivikakk/comrak/pull/419

Full Changelog: https://github.com/kivikakk/comrak/compare/0.23.0...v0.24.1

Full Changelog: https://github.com/kivikakk/comrak/compare/v0.23.1-pre.2...v0.23.1-pre.3

What's Changed

• Miscellany. by @kivikakk in https://github.com/kivikakk/comrak/pull/387
• Add automation to release new crates by @gjtorikian in https://github.com/kivikakk/comrak/pull/374
• build(deps): bump emojis from 0.5.2 to 0.6.2 by @dependabot in https://github.com/kivikakk/comrak/pull/393
• build(deps): bump arbitrary from 1.3.0 to 1.3.2 by @dependabot in https://github.com/kivikakk/comrak/pull/394

Full Changelog: https://github.com/kivikakk/comrak/compare/0.23.0...v0.23.1-pre.2

What's Changed

• add traverse() demo example by @kaesluder in https://github.com/kivikakk/comrak/pull/370
• Avoid backslashes before a new block. by @jneem in https://github.com/kivikakk/comrak/pull/373
• Expand traverse and descendants documentation: Issue #369 by @kaesluder in https://github.com/kivikakk/comrak/pull/375
• Feat/inplace: add new parameter --inplace (-i) for in-place formatting by @bioinformatist in https://github.com/kivikakk/comrak/pull/377
• Change relaxed-autolinks to allow any url scheme by @digitalmoksha in https://github.com/kivikakk/comrak/pull/380
• Fix sourcepos for setext headers by @digitalmoksha in https://github.com/kivikakk/comrak/pull/381
• Add iterative search/replace example to examples and README.md by @kaesluder in https://github.com/kivikakk/comrak/pull/383
• un-Nix in CI. by @kivikakk in https://github.com/kivikakk/comrak/pull/384
• Return brackets in autolinks behavior back to cmark-gfm by @digitalmoksha in https://github.com/kivikakk/comrak/pull/386

New Contributors

• @kaesluder made their first contribution in https://github.com/kivikakk/comrak/pull/370
• @jneem made their first contribution in https://github.com/kivikakk/comrak/pull/373
• @bioinformatist made their first contribution in https://github.com/kivikakk/comrak/pull/377

Full Changelog: https://github.com/kivikakk/comrak/compare/0.22.0...0.23.0

What's Changed

• Fix broken docs link in README by @ohakutsu in https://github.com/kivikakk/comrak/pull/364
• Make non public nodes public by @mfontanini in https://github.com/kivikakk/comrak/pull/363
• cargo update -p rustix --precise 0.36.17 by @kivikakk in https://github.com/kivikakk/comrak/pull/368
• Add render option to wrap escaped chars in span by @digitalmoksha in https://github.com/kivikakk/comrak/pull/367
• Add math support by @digitalmoksha in https://github.com/kivikakk/comrak/pull/366

New Contributors

• @ohakutsu made their first contribution in https://github.com/kivikakk/comrak/pull/364
• @mfontanini made their first contribution in https://github.com/kivikakk/comrak/pull/363

Full Changelog: https://github.com/kivikakk/comrak/compare/0.21.0...0.22.0

What's Changed

• Add a multiline blockquote extension by @digitalmoksha in https://github.com/kivikakk/comrak/pull/359

Full Changelog: https://github.com/kivikakk/comrak/compare/0.20.0...0.21.0

What's Changed

• build(deps): bump rustix from 0.36.11 to 0.36.16 in /fuzz by @dependabot in https://github.com/kivikakk/comrak/pull/346
• Use Nix for CI. by @charlottia in https://github.com/kivikakk/comrak/pull/338
• Allow for Syntect to simply generate CSS classes by @gjtorikian in https://github.com/kivikakk/comrak/pull/347

New Contributors

• @charlottia made their first contribution in https://github.com/kivikakk/comrak/pull/338

Full Changelog: https://github.com/kivikakk/comrak/compare/0.19.0...0.20.0

What's Changed

• Simplify anchorize() by @kornelski in https://github.com/kivikakk/comrak/pull/297
• Use footnote name for reference id by @digitalmoksha in https://github.com/kivikakk/comrak/pull/300
• Escape footnote name by @digitalmoksha in https://github.com/kivikakk/comrak/pull/308
• Add in-doc labels for public facing features by @CosmicHorrorDev in https://github.com/kivikakk/comrak/pull/304
• build(deps): bump xml-rs from 0.8.4 to 0.8.14 by @dependabot in https://github.com/kivikakk/comrak/pull/312
• Handle footnote names that have been parsed into multiple nodes by @digitalmoksha in https://github.com/kivikakk/comrak/pull/311
• Sync with cmark-gfm-0.29.0.gfm.3 by @digitalmoksha in https://github.com/kivikakk/comrak/pull/313
• Sync with cmark-gfm-0.29.0.gfm.4 by @digitalmoksha in https://github.com/kivikakk/comrak/pull/314
• Sync with cmark-gfm-0.29.0.gfm.5 by @digitalmoksha in https://github.com/kivikakk/comrak/pull/315
• Fix backslash in a link issue by @vpetrigo in https://github.com/kivikakk/comrak/pull/317
• Sync with cmark-gfm-0.29.0.gfm.7 by @digitalmoksha in https://github.com/kivikakk/comrak/pull/318
• Rename ComrakFoo types to just Foo for easier usage by @tgross35 in https://github.com/kivikakk/comrak/pull/320
• Make ComrakExtensionOptions non-exhaustive by @CosmicHorrorDev in https://github.com/kivikakk/comrak/pull/305
• Add builder derive and non_exhaustive for option structs by @YJDoc2 in https://github.com/kivikakk/comrak/pull/292
• add PartialEq and Eq derive for Ast and its components by @YJDoc2 in https://github.com/kivikakk/comrak/pull/322
• Sync with cmark-gfm-0.29.0.gfm.11 by @digitalmoksha in https://github.com/kivikakk/comrak/pull/319
• Fix autolink detection inside wiki style link brackets by @digitalmoksha in https://github.com/kivikakk/comrak/pull/325
• Add CI for running benchmarks by @YJDoc2 in https://github.com/kivikakk/comrak/pull/326
• Make adapters Send + Sync by @lucperkins in https://github.com/kivikakk/comrak/pull/337
• docs: fix-up broken docs.rs link by @silverjam in https://github.com/kivikakk/comrak/pull/341
• Use github/cmark-gfm submodule by @digitalmoksha in https://github.com/kivikakk/comrak/pull/344
• Sync with cmark-gfm-0.29.0.gfm.12 by @digitalmoksha in https://github.com/kivikakk/comrak/pull/343
• Sync with cmark-gfm-0.29.0.gfm.13 by @digitalmoksha in https://github.com/kivikakk/comrak/pull/345

New Contributors

• @kornelski made their first contribution in https://github.com/kivikakk/comrak/pull/297
• @CosmicHorrorDev made their first contribution in https://github.com/kivikakk/comrak/pull/304
• @vpetrigo made their first contribution in https://github.com/kivikakk/comrak/pull/317
• @tgross35 made their first contribution in https://github.com/kivikakk/comrak/pull/320
• @YJDoc2 made their first contribution in https://github.com/kivikakk/comrak/pull/292
• @silverjam made their first contribution in https://github.com/kivikakk/comrak/pull/341

Full Changelog: https://github.com/kivikakk/comrak/compare/0.18.0...0.19.0

What's Changed

• Improve performance of bundled plugins, and streaming I/O by @kivikakk in https://github.com/kivikakk/comrak/pull/288
• Implement Default for enums without using #[default] attribute by @silverpill in https://github.com/kivikakk/comrak/pull/293
• XML and sourcepos support by @kivikakk in https://github.com/kivikakk/comrak/pull/232
• Add a quadratic fuzzer by @philipturnbull in https://github.com/kivikakk/comrak/pull/295

New Contributors

• @philipturnbull made their first contribution in https://github.com/kivikakk/comrak/pull/295

Full Changelog: https://github.com/kivikakk/comrak/compare/0.17.1...0.18.0

What's Changed

• Fix some panics found by trivial fuzzing.

Full Changelog: https://github.com/kivikakk/comrak/compare/0.17.0...0.17.1

What's Changed

This contains some breaking changes from an API point of view, but output is largely unchanged. Spec compliance is improved, and benchmark runtime is over 20% faster.

• SECURITY: GHSA-8hqf-xjwp-p67v / Quadratic runtime when parsing Markdown (GHSL-2023-047)
  • A variety of quadratic runtime issues that could lead to DoS were reported and addressed.
  • We replaced pest with an re2c-based scanner.
• SECURITY: GHSA-xxmq-4vph-956w / Excessive output when parsing Markdown (GHSL-2023-048)
  • Reference output is limited to 100Kb.
• SECURITY: GHSA-5r3x-p7xx-x6q5 / Attacker controlled data in AST nodes is not validated (GHSL-2023-049)
  • AST nodes no longer store raw Vec<u8>s, and instead store Strings.
• Various API points were cleaned up.
• Comrak now targets Rust 2018.
• Add footnote attributes that mirror cmark-gfm by @digitalmoksha in https://github.com/kivikakk/comrak/pull/273
• Add support for full_info_string render option by @digitalmoksha in https://github.com/kivikakk/comrak/pull/276
• chore: improve debug performance by @conradludgate in https://github.com/kivikakk/comrak/pull/283

Many thanks to @philipturnbull and @darakian of the GitHub Security Lab for bringing these issues to my attention and detailing the reproduction steps for each case.

New Contributors

• @digitalmoksha made their first contribution in https://github.com/kivikakk/comrak/pull/273
• @conradludgate made their first contribution in https://github.com/kivikakk/comrak/pull/283

Full Changelog: https://github.com/kivikakk/comrak/compare/0.16.0...0.17.0

What's Changed

• Track which symbol was used to mark task item as checked by @felipesere in https://github.com/kivikakk/comrak/pull/252
• improve tagfilter performance by @fiji-flo in https://github.com/kivikakk/comrak/pull/256
• [ShortCode] Add support for gemojis via shortcodes extension by @eklipse2k8 in https://github.com/kivikakk/comrak/pull/260
• "mod three rule" fix by @kivikakk in https://github.com/kivikakk/comrak/pull/262
• Add shortcodes to the README by @gjtorikian in https://github.com/kivikakk/comrak/pull/263
• Cargo.toml: remove timebomb by @kivikakk in https://github.com/kivikakk/comrak/pull/264
• Add custom heading adapter by @lucperkins in https://github.com/kivikakk/comrak/pull/266
• Keep track of "^" symbol when within footnotes by @gjtorikian in https://github.com/kivikakk/comrak/pull/274

New Contributors

• @felipesere made their first contribution in https://github.com/kivikakk/comrak/pull/252
• @fiji-flo made their first contribution in https://github.com/kivikakk/comrak/pull/256
• @eklipse2k8 made their first contribution in https://github.com/kivikakk/comrak/pull/260
• @lucperkins made their first contribution in https://github.com/kivikakk/comrak/pull/266

Full Changelog: https://github.com/kivikakk/comrak/compare/0.15.0...0.16.0

What's Changed

• table: fix start_line of Table itself by @kivikakk in https://github.com/kivikakk/comrak/pull/231
• Rename header file to match c libname by @gjtorikian in https://github.com/kivikakk/comrak/pull/233
• Change the name of the ifdef by @gjtorikian in https://github.com/kivikakk/comrak/pull/234
• Add comrak_set_parse_option_smart by @gjtorikian in https://github.com/kivikakk/comrak/pull/235
• Allow c_char options to be NULL by @gjtorikian in https://github.com/kivikakk/comrak/pull/237
• Replace lazy_static dependency with once_cell by @Turbo87 in https://github.com/kivikakk/comrak/pull/238
• Make comrak --help readable on my terminal by @mgeisler in https://github.com/kivikakk/comrak/pull/242
• c-api: fix CI build by @kivikakk in https://github.com/kivikakk/comrak/pull/240
• Bump versions of some dependencies by @helmet91 in https://github.com/kivikakk/comrak/pull/243
• Adding functionality to build SyntectAdapters with custom themes, syntax sets, etc. by @ArvinSKushwaha in https://github.com/kivikakk/comrak/pull/239
• Make shell-words and xdg dependencies optional by @silverpill in https://github.com/kivikakk/comrak/pull/245
• Bump clap version to 4.0 and switch to the Derive API by @tranzystorek-io in https://github.com/kivikakk/comrak/pull/248
• c-api: remove by @kivikakk in https://github.com/kivikakk/comrak/pull/249

New Contributors

• @Turbo87 made their first contribution in https://github.com/kivikakk/comrak/pull/238
• @mgeisler made their first contribution in https://github.com/kivikakk/comrak/pull/242
• @ArvinSKushwaha made their first contribution in https://github.com/kivikakk/comrak/pull/239
• @silverpill made their first contribution in https://github.com/kivikakk/comrak/pull/245
• @tranzystorek-io made their first contribution in https://github.com/kivikakk/comrak/pull/248

Full Changelog: https://github.com/kivikakk/comrak/compare/0.14.0...0.15.0

crates.io: https://crates.io/crates/comrak/0.15.0

What's Changed

• Allow for C-style dynamic libraries to be produced by @gjtorikian in https://github.com/kivikakk/comrak/pull/171
• Fix wrapping on lines succeeded by unwrappable lines by @edwardloveall in https://github.com/kivikakk/comrak/pull/228
• Add bullet list style options by @edwardloveall in https://github.com/kivikakk/comrak/pull/229

New Contributors

• @edwardloveall made their first contribution in https://github.com/kivikakk/comrak/pull/228

Full Changelog: https://github.com/kivikakk/comrak/compare/0.13.2...0.14.0

crates.io: https://crates.io/crates/comrak/0.14.0

Changes since last release (https://github.com/kivikakk/comrak/compare/0.13.1...0.13.2)

• Fix Windows build.

On crates.io: https://crates.io/crates/comrak/0.13.2

Changes since last release (https://github.com/kivikakk/comrak/compare/0.13.0...0.13.1)

• Support compiling for WASM. (#222, Ben Wishoshavich)
• Replace deprecated twoway dependency. (#224)

On crates.io: https://crates.io/crates/comrak/0.13.1

Windows build includes c465cb5.

Changes since last release (https://github.com/kivikakk/comrak/compare/0.12.1...0.13.0)

• SECURITY: Bump regex to 1.5.5. (#221, Dependabot)
• Drop unneeded YAML dependency from Syntect. (#199, Chris Wong)
• Match newline handling in code inlines to upstream, and improve test failure reporting. (#210, Michael Anderson)
• Make all node value fields public. (#216, Evan Schwartz)
• Line break handling adjustments. (#214, Michael Anderson)
• Disable control characters in link definitions. (#219, Michael Anderson)

On crates.io: https://crates.io/crates/comrak/0.13.0

Changes since last release (https://github.com/kivikakk/comrak/compare/0.12.0...0.12.1)

• Only load syntax and theme sets once, on Syntect plugin instantiation. (#197)
• Match syntax highlighting language names more loosely. (#198)

On crates.io: https://crates.io/crates/comrak/0.12.1