#deno #doc #node

deno_doc

doc generation for deno

14 releases

new 0.1.13 Oct 22, 2020
0.1.12 Oct 17, 2020
0.1.9 Sep 13, 2020
0.1.3 Aug 30, 2020
Download history 431/week @ 2020-08-15 2011/week @ 2020-08-22 1292/week @ 2020-08-29 1140/week @ 2020-09-05 609/week @ 2020-09-12 375/week @ 2020-09-19 621/week @ 2020-09-26 1247/week @ 2020-10-03 955/week @ 2020-10-10 2898/week @ 2020-10-17

3,677 downloads per month
Used in deno

MIT license

170KB
5.5K SLoC

deno_doc

A Rust crate to generate documentation for JavaScript and TypeScript modules.

This crate powers deno doc, but is not Deno specific and can be used to write documentation generators for other targets like Node or the browser as well.

Example

examples/ddoc/main.rs provides a minimal standalone binary demonstrating how deno_doc can be used as a crate.

$ cargo run --example ddoc ../deno/std/http/mod.ts

Developing

Make sure to have latest stable version of Rust installed (1.45.0).

// check version
$ rustc --version
rustc 1.45.0 (5c1f21c3b 2020-07-13)

// build all targets
$ cargo build --all-targets

// test it
$ cargo test

Contributing

Submitting a Pull Request

Before submitting, please make sure the following is done:

  1. That there is a related issue and it is referenced in the PR text.
  2. There are tests that cover the changes.
  3. Ensure cargo test passes.
  4. Format your code with rustfmt --check src/lib.rs
  5. Make sure cargo clippy --all-targets --release --locked -- -D clippy::all passes.

Dependencies

~7MB
~161K SLoC