Coder Social home page Coder Social logo

bartlomieju / deno_doc Goto Github PK

View Code? Open in Web Editor NEW

This project forked from denoland/deno_doc

1.0 1.0 1.0 45.61 MB

Documentation generator for Deno

License: MIT License

Rust 93.41% Dockerfile 0.16% TypeScript 2.12% JavaScript 1.26% CSS 2.29% HTML 0.76%

deno_doc's Introduction


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.

Usage from Deno CLI or Deploy

See js/

Rust Example

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

$ cargo run --example ddoc ../deno_std/http/mod.ts


# build all targets
$ cargo build --all-targets

# test it
$ cargo test

# build js api
$ deno task build

# test it
$ deno task test


  • 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.

  • Ask for help in the community chat room.

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/
  5. Make sure cargo clippy --all-targets --release --locked -- -D clippy::all passes.

deno_doc's People


aaron1011 avatar aninternettroll avatar bartlomieju avatar caspervonb avatar chansuke avatar clo4 avatar crowlkats avatar denobot avatar dsherret avatar kitsonk avatar kt3k avatar liamolucko avatar lino-levan avatar littledivy avatar lucacasonato avatar magurotuna avatar mlafeldt avatar not-my-profile avatar peaceiris avatar roj1512 avatar satyarohith avatar spencerisgiddy avatar uki00a avatar ultirequiem avatar vehmloewff avatar zhmushan avatar







Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.