Pixilab
Home › Companies › Show HN launch › Rustdoc-style linking in mdBook (with the help of Rust-analyzer)

Rustdoc-style linking in mdBook (with the help of Rust-analyzer)

Show HN: Rustdoc-style linking in mdBook (with the help of Rust-analyzer)

Rustdoc-style linking in mdBook (with the help of Rust-analyzer) is active in the show hn launch space.

Profile

[rustdoc], Rust's API documentation generator, supports linking to Rust APIs by names, which is great DX because you don't have to hard-code URLs in docs, and it guarantees the links are correct. The same feature can be found in Javadoc, Go Doc, etc.[mdBook] is another documentation/static-site generator written in Rust and widely used in the Rust community. It generates sites from Markdown (so like Docusaurus, VitePress, etc.)Unlike rustdoc, mdBook doesn't have the same "linking by name" capability, which I find a bit lacking — so I made this program!mdbook-rustdoc-link is an mdBook preprocessor that you can plug into your book projects. Using [rust-analyzer], it converts Rust API names to

Rustdoc-style linking in mdBook (with the help of Rust-analyzer) is positioned in show hn launch, a segment that rewards a clear, focused offering.

The company is listed at the Show HN launch stage of development.

SectorShow HN launch
StageShow HN launch

Website: tonywu6.github.io/mdbookkit/rustdoc-link

Browse related

Full contact details are available to registered Pixilab members.
Create a free account