Skip to content

Commit

Permalink
Add FAQ to README
Browse files Browse the repository at this point in the history
Makes it easier to discover how to enable showing the URL on hover.
Added FAQ heading in documentation so that it can be linked to directly.
  • Loading branch information
lampsitter committed Nov 5, 2024
1 parent 11e6575 commit 52cde89
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,21 @@ commonmark_str!(ui, &mut cache, "content.md");
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.

## FAQ

### URL is not displayed when hovering over a link

By default egui does not show urls when you hover hyperlinks. To enable it,
you can do the following before calling any ui related functions:

```rust
ui.style_mut().url_in_tooltip = true;
```

## MSRV Policy

This crate uses the same MSRV as the latest released egui version.

## License

Licensed under either of
Expand Down
3 changes: 3 additions & 0 deletions egui_commonmark/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@
//! ```toml
//! image = { version = "0.25", default-features = false, features = ["png"] }
//! ```
//! # FAQ
//!
//! ## URL is not displayed when hovering over a link
//!
//! By default egui does not show urls when you hover hyperlinks. To enable it,
//! you can do the following before calling any ui related functions:
Expand Down

0 comments on commit 52cde89

Please sign in to comment.