25 releases (14 breaking)
0.15.0 | Apr 2, 2024 |
---|---|
0.14.0 | Mar 26, 2024 |
0.13.0 | Feb 20, 2024 |
0.10.2 | Dec 13, 2023 |
0.1.3 | Mar 24, 2022 |
#56 in GUI
10,587 downloads per month
Used in 18 crates
(4 directly)
80KB
2K
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.15"
# Specify what image formats you want to use
image = { version = "0.24", default-features = false, features = ["png"] }
use egui_commonmark::*;
let markdown =
r"# Hello world
* A list
* [ ] Checkbox
";
let mut cache = CommonMarkCache::default();
CommonMarkViewer::new("viewer").show(ui, &mut cache, markdown);
Features
better_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–21MB
~232K SLoC