inline-doc

Crates.ioinline-doc
lib.rsinline-doc
version0.1.0
created_at2025-01-25 14:50:30.753973+00
updated_at2025-01-25 14:50:30.753973+00
descriptionEmbed markdown/text files as documentation
homepage
repositoryhttps://github.com/RobertasJ/inline-doc
max_upload_size
id1530649
size4,445
_Robertas (RobertasJ)

documentation

README

inline-doc

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.

Example usage

#[inline_doc("src/docs/thing/documentation.md")]
struct Thing;

#[inline_doc("src/docs/thing.md")]
fn thing() {}

NOTE

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.

Commit count: 5

cargo fmt