Skip to content

Convert pulldown-cmark Events back to the string they were parsed from

License

Notifications You must be signed in to change notification settings

Byron/pulldown-cmark-to-cmark

Repository files navigation

Crates.io Rust

A utility library which translates Event back to markdown. It's the prerequisite for writing markdown filters which can work as mdbook-preprocessors.

This library takes great pride in supporting everything that pulldown-cmark supports, including tables and footnotes and codeblocks in codeblocks, while assuring quality with a powerful test suite.

How to use

Please have a look at the stupicat-example for a complete tour of the API, or have a look at the api-docs.

It's easiest to get this library into your Cargo.toml using cargo-add:

cargo add pulldown-cmark-to-cmark

Supported Rust Versions

pulldown-cmark-to-cmark follows the MSRV (minimum supported rust version) policy of pulldown-cmark. The current MSRV is 1.71.1.

Friends of this project

  • termbook
    • A runner for mdbooks to keep your documentation tested.
  • Share Secrets Safely
    • share secrets within teams to avoid plain-text secrets from day one

Maintenance Guide

Making a new release

  • Assure all documentation is up-to-date and tests are green
  • update the version in Cargo.toml and git commit
  • run cargo release --no-dev-version