| Crates.io | inline-doc |
| lib.rs | inline-doc |
| version | 0.1.0 |
| created_at | 2025-01-25 14:50:30.753973+00 |
| updated_at | 2025-01-25 14:50:30.753973+00 |
| description | Embed markdown/text files as documentation |
| homepage | |
| repository | https://github.com/RobertasJ/inline-doc |
| max_upload_size | |
| id | 1530649 |
| size | 4,445 |
A working version of
#[doc = include_str!("path")]
Important to note that the path goes from the root of the project.
This project was inspired by lsp_doc and made to work on stable.
#[inline_doc("src/docs/thing/documentation.md")]
struct Thing;
#[inline_doc("src/docs/thing.md")]
fn thing() {}
When you change anything you need to restart rust-analyzer for the documentation to come into effect. rust-analyzer caches files so it wont update automatically.