aboutsummaryrefslogtreecommitdiffstats
path: root/readme.md
diff options
context:
space:
mode:
authorLibravatar Titus Wormer <tituswormer@gmail.com>2022-12-13 13:15:46 +0400
committerLibravatar Titus Wormer <tituswormer@gmail.com>2022-12-13 13:15:46 +0400
commita8f5da1524761c5f55deca36c34ff8aee061bf32 (patch)
tree15600441c150bf63879a34285e99dd0b6843687a /readme.md
parent6f3b15b67a96f660ad67ee8fdbe109b2e0bf88f4 (diff)
downloadmarkdown-rs-a8f5da1524761c5f55deca36c34ff8aee061bf32.tar.gz
markdown-rs-a8f5da1524761c5f55deca36c34ff8aee061bf32.tar.bz2
markdown-rs-a8f5da1524761c5f55deca36c34ff8aee061bf32.zip
1.0.0-alpha.5
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 55091ea..70f6fb1 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.4`.
+> Make sure to use the new crate, currently in alpha at `1.0.0-alpha.5`.
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.4
+cargo add markdown@1.0.0-alpha.5
```
> 👉 **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.4`.
+> Make sure to use the new crate, currently in alpha at `1.0.0-alpha.5`.
## Use
@@ -151,10 +151,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.4/markdown/fn.to_html.html),
-[`to_html_with_options`](https://docs.rs/markdown/1.0.0-alpha.4/markdown/fn.to_html_with_options.html),
-[`to_mdast`](https://docs.rs/markdown/1.0.0-alpha.4/markdown/fn.to_mdast.html),
-[`Options`](https://docs.rs/markdown/1.0.0-alpha.4/markdown/struct.Options.html),
+[`to_html`](https://docs.rs/markdown/1.0.0-alpha.5/markdown/fn.to_html.html),
+[`to_html_with_options`](https://docs.rs/markdown/1.0.0-alpha.5/markdown/fn.to_html_with_options.html),
+[`to_mdast`](https://docs.rs/markdown/1.0.0-alpha.5/markdown/fn.to_mdast.html),
+[`Options`](https://docs.rs/markdown/1.0.0-alpha.5/markdown/struct.Options.html),
and a few other structs and enums.
See the [crate docs][docs] for more info.
@@ -348,11 +348,11 @@ Special thanks go out to:
[docs-badge]: https://img.shields.io/docsrs/markdown
-[docs]: https://docs.rs/markdown/1.0.0-alpha.4/markdown/
+[docs]: https://docs.rs/markdown/1.0.0-alpha.5/markdown/
[crate-badge]: https://img.shields.io/crates/v/markdown
-[crate]: https://crates.io/crates/markdown/1.0.0-alpha.4
+[crate]: https://crates.io/crates/markdown/1.0.0-alpha.5
[chat]: https://github.com/wooorm/markdown-rs/discussions