Skip to content

RobertasJ/inline-doc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

Embed markdown/text files as documentation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages