https://github.com/ciffelia/discord-md
Parser and generator for Discord's markdown, written in Rust
https://github.com/ciffelia/discord-md
crate discord markdown parser rust rust-crate
Last synced: about 1 month ago
JSON representation
Parser and generator for Discord's markdown, written in Rust
- Host: GitHub
- URL: https://github.com/ciffelia/discord-md
- Owner: ciffelia
- License: apache-2.0
- Created: 2021-09-01T07:28:33.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-08-15T18:34:12.000Z (about 2 months ago)
- Last Synced: 2025-08-17T09:51:33.591Z (about 2 months ago)
- Topics: crate, discord, markdown, parser, rust, rust-crate
- Language: Rust
- Homepage: https://crates.io/crates/discord-md
- Size: 152 KB
- Stars: 17
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# discord-md
[![CI status][ci badge]][ci link]
[![crate version][crates.io badge]][crates.io link]
[![docs online][docs badge]][docs link]
[![MIT or Apache 2.0 Licenses][license badge]][license link]
Parser and generator for Discord's markdown, written in Rust
## Example
### Parsing
```rust
use discord_md::ast::*;
use discord_md::parse;
fn main() {
let message = "You can write *italics text*, `*inline code*`, and more!";
let ast = MarkdownDocument::new(vec![
MarkdownElement::Plain(Box::new(
Plain::new("You can write ")
)),
MarkdownElement::ItalicsStar(Box::new(
ItalicsStar::new(vec![
MarkdownElement::Plain(Box::new(
Plain::new("italics text")
))
])
)),
MarkdownElement::Plain(Box::new(
Plain::new(", ")
)),
MarkdownElement::OneLineCode(Box::new(
OneLineCode::new("*inline code*")
)),
MarkdownElement::Plain(Box::new(
Plain::new(", and more!")
)),
]);
assert_eq!(
parse(message),
ast
);
}
```
### Generating
```rust
use discord_md::ast::MarkdownDocument;
use discord_md::builder::*;
fn main() {
let ast = MarkdownDocument::new(vec![
plain("generating "),
one_line_code("markdown"),
plain(" is "),
underline(vec![
bold("easy"),
plain(" and "),
bold("fun!"),
]),
]);
assert_eq!(
ast.to_string(),
"generating `markdown` is __**easy** and **fun!**__"
);
}
```
## Features
- Minimal dependencies (only [nom](https://github.com/rust-bakery/nom) and [derive_more](https://github.com/JelteF/derive_more))
- Supports the following syntax:
- Italics (`*italics*`, `_italics_`)
- Bold (`**bold**`)
- Underline (`__underline__`)
- Strikethrough (`~~strikethrough~~`)
- Spoiler (`||spoiler||`)
- One line code (`` `one line code` ``)
- Multi line code
````
```sh
echo "multi line"
echo "code"
```
````
- Block Quote ([generator only](#parser-limitations))
```
> block quote
> some text
```
## Installation
Add the following to your `Cargo.toml` file:
```toml
[dependencies]
discord-md = "3.0.0"
```
## Documentation
[Available at docs.rs][docs link]
## Parser limitations
The parser tries to mimic the behavior of the official Discord client's markdown parser, but it's not perfect.
The following is the list of known limitations.
- Block quotes are not parsed. `> ` will be treated as plain text.
- Nested emphasis, like `*italics **bold italics** italics*`, may not be parsed properly.
- Intraword emphasis may not be handled properly. The parser treats `foo_bar_baz` as emphasis, while Discord's parser does not.
- Escaping sequence will be treated as plain text.
## License
Licensed under either of
* Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license
([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
[ci badge]: https://github.com/ciffelia/discord-md/actions/workflows/ci.yml/badge.svg
[ci link]: https://github.com/ciffelia/discord-md/actions/workflows/ci.yml
[crates.io badge]: https://img.shields.io/crates/v/discord-md
[crates.io link]: https://crates.io/crates/discord-md
[docs badge]: https://img.shields.io/badge/docs-online-green
[docs link]: https://docs.rs/discord-md
[license badge]: https://img.shields.io/badge/license-MIT%20or%20Apache%202.0-blue
[license link]: #license