aboutsummaryrefslogtreecommitdiffstats
path: root/readme.md
diff options
context:
space:
mode:
authorLibravatar Titus Wormer <tituswormer@gmail.com>2022-10-25 13:05:01 +0200
committerLibravatar Titus Wormer <tituswormer@gmail.com>2022-10-25 13:05:01 +0200
commitcd782d3c3563ef711905429c6d9e1a88acf14fd7 (patch)
tree4fd396b8b1c4289345426628f4a76607d3db9180 /readme.md
parentad1b3e62aba27afa19577b18d71b1c0ac4509847 (diff)
downloadmarkdown-rs-cd782d3c3563ef711905429c6d9e1a88acf14fd7.tar.gz
markdown-rs-cd782d3c3563ef711905429c6d9e1a88acf14fd7.tar.bz2
markdown-rs-cd782d3c3563ef711905429c6d9e1a88acf14fd7.zip
1.0.0-alpha.2
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/readme.md b/readme.md
index 932e0b1..17dd465 100644
--- a/readme.md
+++ b/readme.md
@@ -16,7 +16,7 @@
> 👉 **Note**: this is a new crate that reuses an old name.
> The old crate (`0.3.0` and lower) has a bunch of problems.
-> Make sure to use the new crate, currently in alpha at `1.0.0-alpha.1`.
+> Make sure to use the new crate, currently in alpha at `1.0.0-alpha.2`.
CommonMark compliant markdown parser in Rust with ASTs and extensions.
@@ -80,12 +80,12 @@ This Rust crate has a sibling project in JavaScript: [`micromark`][micromark]
With [Rust][] (rust edition 2018+, ±version 1.56+), install with `cargo`:
```sh
-cargo add markdown@1.0.0-alpha.1
+cargo add markdown@1.0.0-alpha.2
```
> 👉 **Note**: this is a new crate that reuses an old name.
> The old crate (`0.3.0` and lower) has a bunch of problems.
-> Make sure to use the new crate, currently in alpha at `1.0.0-alpha.1`.
+> Make sure to use the new crate, currently in alpha at `1.0.0-alpha.2`.
## Use
@@ -157,10 +157,10 @@ Root { children: [Heading { children: [Text { value: "Hey, ", position: Some(1:3
## API
`markdown-rs` exposes
-[`to_html`](https://docs.rs/markdown/1.0.0-alpha.1/markdown/fn.to_html.html),
-[`to_html_with_options`](https://docs.rs/markdown/1.0.0-alpha.1/markdown/fn.to_html_with_options.html),
-[`to_mdast`](https://docs.rs/markdown/1.0.0-alpha.1/markdown/fn.to_mdast.html),
-[`Options`](https://docs.rs/markdown/1.0.0-alpha.1/markdown/struct.Options.html),
+[`to_html`](https://docs.rs/markdown/1.0.0-alpha.2/markdown/fn.to_html.html),
+[`to_html_with_options`](https://docs.rs/markdown/1.0.0-alpha.2/markdown/fn.to_html_with_options.html),
+[`to_mdast`](https://docs.rs/markdown/1.0.0-alpha.2/markdown/fn.to_mdast.html),
+[`Options`](https://docs.rs/markdown/1.0.0-alpha.2/markdown/struct.Options.html),
and a few other structs and enums.
See the [crate docs][docs] for more info.
@@ -350,11 +350,11 @@ Special thanks go out to:
[docs-badge]: https://img.shields.io/docsrs/markdown
-[docs]: https://docs.rs/markdown/1.0.0-alpha.1/markdown/
+[docs]: https://docs.rs/markdown/1.0.0-alpha.2/markdown/
[crate-badge]: https://img.shields.io/crates/v/markdown
-[crate]: https://crates.io/crates/markdown/1.0.0-alpha.1
+[crate]: https://crates.io/crates/markdown/1.0.0-alpha.2
[chat]: https://github.com/wooorm/markdown-rs/discussions