kurtlawrence / cargo-modoc

Generate module documentation from markdown files

Generate Rust module documentation from markdown files.

Apply module documentation to a source file from a markdown file. This binary takes a markdown file and prepends a source file with the module documentation comments (//!). There is a configuration file at the root directory (modoc.config) which defines which markdown files are to prepend which source files, in a single input multiple output fashion.

To get started, use cargo to install the binary.

cargo install cargo-modoc

A configuration file needs to be set up.

# Commends are allowed
"README.md" = [ "src/main.rs", "src/lib.rs" ]

A single markdown file can apply to multiple source files.

Run the binary to write the markdown contents to the source files.

cargo modoc

The binary will read the contents of the markdown file and prepend the source file with the line comments (//!). If there are any lines in the source file which start with //! then these lines are not included (hence the documentation is overwritten).

cargo-modoc's Issues

Remove cratesiover version

Remove the cratesiover dependency -- unnecessary

Thanks!

Hey there, just wanted to say thanks real quick for this nifty tool. And its so tiny. :)

I was surprised I couldn't find anything else to do this. I thought there should be a macro or something, but nothing I found prevented me from having to manually update my lib.rs docstring. 😃

You got my ⭐.