#markdown #rustdoc #readme

rustdoc-to-markdown

Transform code blocks from rustdoc into markdown

1 unstable release

0.1.0 Jul 9, 2022

#17 in #readme


Used in 2 crates (via move-readme-generator)

Apache-2.0

13KB
318 lines

rustdoc-to-markdown

Transform code blocks from rustdoc into markdown

Rewrite code block start tags, changing rustdoc into equivalent in markdown:

  • "", "no_run", "ignore" and "should_panic" are converted to "```rust"
  • markdown heading are indentend to be one level lower, so the crate name is at the top level

Code taken almost verbatim from https://github.com/livioribeiro/cargo-readme/blob/a7fd456433832f873cee890a9e67ece9929fc795/src/readme/process.rs.

License: Apache-2.0


lib.rs:

Transform code blocks from rustdoc into markdown

Rewrite code block start tags, changing rustdoc into equivalent in markdown:

  • "", "no_run", "ignore" and "should_panic" are converted to "```rust"
  • markdown heading are indentend to be one level lower, so the crate name is at the top level

Code taken almost verbatim from https://github.com/livioribeiro/cargo-readme/blob/a7fd456433832f873cee890a9e67ece9929fc795/src/readme/process.rs.

Dependencies

~2.1–3MB
~53K SLoC