Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 03-May-2022 | - | ||||
src/ | H | 03-May-2022 | - | 537 | 460 | |
.cargo-checksum.json | H A D | 03-May-2022 | 89 | 1 | 1 | |
.cargo_vcs_info.json | H A D | 01-Jan-1970 | 94 | 6 | 6 | |
CHANGELOG.md | H A D | 29-Nov-1973 | 25.9 KiB | 580 | 378 | |
Cargo.lock | H A D | 01-Jan-1970 | 4.3 KiB | 169 | 148 | |
Cargo.toml | H A D | 01-Jan-1970 | 1.3 KiB | 33 | 30 | |
Cargo.toml.orig-cargo | H A D | 29-Nov-1973 | 810 | 25 | 21 | |
README.md | H A D | 29-Nov-1973 | 1.7 KiB | 42 | 29 |
README.md
1[![Crates.io](https://img.shields.io/crates/v/pulldown-cmark-to-cmark)](https://crates.io/crates/pulldown-cmark-to-cmark) 2![Rust](https://github.com/Byron/pulldown-cmark-to-cmark/workflows/Rust/badge.svg) 3 4A utility library which translates [`Event`][pdcm-event] back to markdown. 5It's the prerequisite for writing markdown filters which can work as 6[mdbook-preprocessors][mdbook-prep]. 7 8This library takes great pride in supporting **everything that `pulldown-cmark`** supports, 9including *tables* and *footnotes* and *codeblocks in codeblocks*, 10while assuring *quality* with a powerful test suite. 11 12[pdcm-event]: https://docs.rs/pulldown-cmark/0.1.0/pulldown_cmark/enum.Event.html 13[mdbook-prep]: https://rust-lang-nursery.github.io/mdBook/for_developers/preprocessors.html 14 15### How to use 16 17Please have a look at the [`stupicat`-example][sc-example] for a complete tour 18of the API, or have a look at the [api-docs][api]. 19 20It's easiest to get this library into your `Cargo.toml` using `cargo-add`: 21``` 22cargo add pulldown-cmark-to-cmark 23``` 24 25[sc-example]: https://github.com/Byron/pulldown-cmark-to-cmark/blob/76667725b61be24890fbdfed5e7ecdb4c1ad1dc8/examples/stupicat.rs#L21 26[api]: https://docs.rs/crate/pulldown-cmark-to-cmark 27 28### Friends of this project 29 30 * [**termbook**](https://github.com/Byron/termbook) 31 * A runner for `mdbooks` to keep your documentation tested. 32 * [**Share Secrets Safely**](https://github.com/Byron/share-secrets-safely) 33 * share secrets within teams to avoid plain-text secrets from day one 34 35### Maintenance Guide 36 37#### Making a new release 38 39 * **Assure all documentation is up-to-date and tests are green** 40 * update the `version` in `Cargo.toml` and `git commit` 41 * run `cargo release --no-dev-version` 42