A simple helper to transform Markdown links to intra-doc links in Rust projects when appropriate.
intraconv.toml
by default when no ignore file is given (#36).primitive.Type.html
links since transforming them is wrong most
of the time (#35).--ignore-file
instead of ----ignore-file
(#37).Date: 2020-11-25
index.html#section
now correctly always link to self
, not the current
page (#34).Date: 2020-11-19
docs.rs
: https://docs.rs/crate-1
will now be transformed to crate_1
when used in a link.https://doc.rust-lang.org
is now supported./// [tracing]: mod@tracing
was previously removed but the mod@
part could be the only thing helping rustdoc find the correct link and so it is necessary to keep the link.cargo intraconv
was an error before. Now it just find the current workspace (either one crate or a group of crates) and search the links in the src
directories. This search is recursive. It is still possible to give only one file to cargo intraconv
and it will only consume this file.[name]: ../metadata
to [name]: super::metadata
.[name](../metadata)
to [name](super::metadata)
. This will also correctly delete the (link)
part if the transformation produces something of the form [name](name)
.[name]: #section
will never change.Date: 2020-10-29
Git tag: v1.1.0
.
https
link from docs.rs
will be transformed to their intra-doc links version. intraconv
will assume such links point to dependencies and as such can be safely transformed to intra-doc links. If this is not the desired behaviour, see the -f
flag.--no-favored
(-f
) to disable the behaviour described above.See CHANGELOG.md for a detailed changelog.
Short changelog:
--version
and --quiet
.cargo-intraconv
is now ready to be used widely and is only waiting on Rust 1.48.0 to get out with stabilised intra-doc links.
You can find it on crates.io as cargo-intraconv
.