https://github.com/byron/pulldown-cmark-to-cmark
Convert pulldown-cmark Events back to the string they were parsed from
https://github.com/byron/pulldown-cmark-to-cmark
markdown markdown-converter
Last synced: about 1 year ago
JSON representation
Convert pulldown-cmark Events back to the string they were parsed from
- Host: GitHub
- URL: https://github.com/byron/pulldown-cmark-to-cmark
- Owner: Byron
- License: apache-2.0
- Created: 2018-02-11T08:43:43.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2025-02-21T07:39:05.000Z (over 1 year ago)
- Last Synced: 2025-05-15T19:03:48.119Z (about 1 year ago)
- Topics: markdown, markdown-converter
- Language: Rust
- Homepage: https://docs.rs/crate/pulldown-cmark-to-cmark
- Size: 479 KB
- Stars: 50
- Watchers: 3
- Forks: 43
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
[](https://crates.io/crates/pulldown-cmark-to-cmark)
A utility library which translates [`Event`][pdcm-event] back to markdown.
It's the prerequisite for writing markdown filters which can work as
[mdbook-preprocessors][mdbook-prep].
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.
[pdcm-event]: https://docs.rs/pulldown-cmark/latest/pulldown_cmark/enum.Event.html
[mdbook-prep]: https://rust-lang.github.io/mdBook/for_developers/preprocessors.html
### How to use
Please have a look at the [`stupicat`-example][sc-example] for a complete tour
of the API, or have a look at the [api-docs][api].
It's easiest to get this library into your `Cargo.toml` using `cargo-add`:
```
cargo add pulldown-cmark-to-cmark
```
[sc-example]: https://github.com/Byron/pulldown-cmark-to-cmark/blob/76667725b61be24890fbdfed5e7ecdb4c1ad1dc8/examples/stupicat.rs#L21
[api]: https://docs.rs/crate/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.
[`pulldown-cmark`]: https://github.com/pulldown-cmark/pulldown-cmark
### Friends of this project
* [**termbook**](https://github.com/Byron/termbook)
* A runner for `mdbooks` to keep your documentation tested.
* [**Share Secrets Safely**](https://github.com/Byron/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`