2 unstable releases
Uses old Rust 2015
|0.2.0||Aug 22, 2019|
|0.1.0||Nov 13, 2016|
#486 in Cargo plugins
This tool allows you to add markdown files to your crate's documentation generated with rustdoc.
The documentation generated by
rustdoc is meant for code and API references,
and does not offer a nice way to add long form documentation. This tool
will fix that until rustlang/cargo#739
cargo external-doc is installed via
$ cargo install cargo-external-doc
Put your articles written in markdown in the
doc/ subfolder of your
project (see nom for an example).
rustdoc requires that the files are prefixed with a title like this:
% Your title here
cargo build then
cargo external-doc. This tool will:
- test the code examples in the files from
- generate html files consistent with
rustdoc's templates and put them in
Your other documentation files can reference it by relative URL, like this for a
cf the [guide](guide.html)
In nom, you can see:
- the online reference with links to articles
- the links in
- the parser writing article and its source
This tool is a temporary solution, until something better is
It does not support overriding values like the target path.
It relies on the
target/debug/libyourcrate.rlib file existing.
It does not check for invalid links.
It is not configurable.
It fits a need I have for nom, and it might
not fit what you want. I'm open to modification ideas and patches, but I'd
prefer to see it implemented correctly in
cargo doc instead.