deno_doc

Crates.iodeno_doc
lib.rsdeno_doc
version0.125.0
sourcesrc
created_at2020-08-18 22:26:55.877263
updated_at2024-04-18 23:22:07.712767
descriptiondoc generation for deno
homepage
repositoryhttps://github.com/denoland/deno_doc
max_upload_size
id278039
size1,861,236
(denobot)

documentation

README

# `deno_doc` A Rust crate to generate documentation for JavaScript and TypeScript modules. This crate powers [`deno doc`](https://deno.land/manual/tools/documentation_generator), but is not Deno specific and can be used to write documentation generators for other targets like Node or the browser as well. ## Usage from Deno CLI or Deploy See [js/README.md](js/README.md). ## Rust Example `examples/ddoc/main.rs` provides a minimal standalone binary demonstrating how `deno_doc` can be used as a crate. ```shell $ cargo run --example ddoc ../deno_std/http/mod.ts ``` ## Developing ```shell # build all targets $ cargo build --all-targets # test it $ cargo test # build js api $ deno task build # test it $ deno task test ``` ## Contributing - If you are going to work on an issue, mention so in the issue comments _before_ you start working on the issue. - Please be professional in the forums. See our [Code of Conduct](https://github.com/denoland/deno/blob/main/.github/CODE_OF_CONDUCT.md). - Ask for help in the [community chat room](https://discord.gg/deno). ## 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` and `deno task 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.
Commit count: 477

cargo fmt