egui_commonmark

Crates.ioegui_commonmark
lib.rsegui_commonmark
version0.15.0
sourcesrc
created_at2022-02-09 11:18:29.858351
updated_at2024-04-02 19:39:54.712725
descriptionCommonmark viewer for egui
homepage
repositoryhttps://github.com/lampsitter/egui_commonmark
max_upload_size
id529632
size177,968
(lampsitter)

documentation

https://docs.rs/egui_commonmark

README

# A commonmark viewer for [egui](https://github.com/emilk/egui) [![Crate](https://img.shields.io/crates/v/egui_commonmark.svg)](https://crates.io/crates/egui_commonmark) [![Documentation](https://docs.rs/egui_commonmark/badge.svg)](https://docs.rs/egui_commonmark) showcase 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: ```toml egui_commonmark = "0.15" # Specify what image formats you want to use image = { version = "0.24", default-features = false, features = ["png"] } ``` ```rust 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 with [`syntect`](https://crates.io/crates/syntect) * `svg`: Support for viewing svg images * `fetch`: 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](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.
Commit count: 228

cargo fmt