aboutsummaryrefslogtreecommitdiffstats
path: root/readme.md
diff options
context:
space:
mode:
authorLibravatar Titus Wormer <tituswormer@gmail.com>2022-10-26 13:28:56 +0200
committerLibravatar Titus Wormer <tituswormer@gmail.com>2022-10-26 13:28:56 +0200
commitb910e37bb387a62509a7fda26617e9870ed6d56f (patch)
tree9dadc531c823045a9aa34b72fb7a184cab384a1e /readme.md
parente139a804a109f1e785238f15d361ada980cca778 (diff)
downloadmarkdown-rs-b910e37bb387a62509a7fda26617e9870ed6d56f.tar.gz
markdown-rs-b910e37bb387a62509a7fda26617e9870ed6d56f.tar.bz2
markdown-rs-b910e37bb387a62509a7fda26617e9870ed6d56f.zip
1.0.0-alpha.3
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 17dd465..d8a064a 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.2`.
+> Make sure to use the new crate, currently in alpha at `1.0.0-alpha.3`.
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.2
+cargo add markdown@1.0.0-alpha.3
```
> 👉 **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.2`.
+> Make sure to use the new crate, currently in alpha at `1.0.0-alpha.3`.
## 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.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),
+[`to_html`](https://docs.rs/markdown/1.0.0-alpha.3/markdown/fn.to_html.html),
+[`to_html_with_options`](https://docs.rs/markdown/1.0.0-alpha.3/markdown/fn.to_html_with_options.html),
+[`to_mdast`](https://docs.rs/markdown/1.0.0-alpha.3/markdown/fn.to_mdast.html),
+[`Options`](https://docs.rs/markdown/1.0.0-alpha.3/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.2/markdown/
+[docs]: https://docs.rs/markdown/1.0.0-alpha.3/markdown/
[crate-badge]: https://img.shields.io/crates/v/markdown
-[crate]: https://crates.io/crates/markdown/1.0.0-alpha.2
+[crate]: https://crates.io/crates/markdown/1.0.0-alpha.3
[chat]: https://github.com/wooorm/markdown-rs/discussions