28 releases (17 breaking)
0.18.0 | Sep 26, 2024 |
---|---|
0.17.0 | Jul 3, 2024 |
0.16.1 | May 12, 2024 |
0.14.0 | Mar 26, 2024 |
0.1.3 | Mar 24, 2022 |
#39 in GUI
21,003 downloads per month
Used in 29 crates
(7 directly)
84KB
1.5K
SLoC
A commonmark viewer for egui
While this crate's main focus is commonmark, it also supports a subset of Github's markdown syntax: tables, strikethrough, tasklists and footnotes.
Usage
In Cargo.toml:
egui_commonmark = "0.18"
# Specify what image formats you want to use
image = { version = "0.25", default-features = false, features = ["png"] }
use egui_commonmark::*;
let markdown =
r"# Hello world
* A list
* [ ] Checkbox
";
let mut cache = CommonMarkCache::default();
CommonMarkViewer::new().show(ui, &mut cache, markdown);
Compile time evaluation of markdown
If you want to embed markdown directly the binary then you can enable the macros
feature.
This will do the parsing of the markdown at compile time and output egui widgets.
Example
use egui_commonmark::{CommonMarkCache, commonmark};
let mut cache = CommonMarkCache::default();
let _response = commonmark!(ui, &mut cache, "# ATX Heading Level 1");
Alternatively you can embed a file
Example
use egui_commonmark::{CommonMarkCache, commonmark_str};
let mut cache = CommonMarkCache::default();
commonmark_str!(ui, &mut cache, "content.md");
Features
macros
: macros for compile time parsing of markdownbetter_syntax_highlighting
: Syntax highlighting inside code blocks withsyntect
svg
: Support for viewing svg imagesfetch
: Images with urls will be downloaded and displayed
Examples
For an easy intro check out the hello_world
example. To see all the different
features egui_commonmark has to offer check out the book
example.
License
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Dependencies
~5–16MB
~219K SLoC