Coder Social home page Coder Social logo

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

This repository includes a compiled version of the Rust crate as Web Assembly and exposes an interface which is available via the mod.ts and can be imported like this:

import { doc } from "[email protected]{VERSION}/mod.ts";

Where {VERSION} should be substituted with the specific version you want to use.


The doc() function takes a string URL module specifier and potentially some options, and asynchronously resolves with an array of documentation nodes, which represent the surface API of the module.

A minimal example of using doc() and printing out some information about a function:

import { doc } from "[email protected]{VERSION}/mod.ts";

const colorsDoc = await doc("");

for (const node of colorsDoc) {
  console.log(`name: ${} kind: ${node.kind}`);

The doc() function needs a way to retrieve modules, and by default uses a load() function provided by deno_graph which uses fetch() for remote modules and Deno.readFile() for local modules. This means that doc() will require that appropriate read/net permissions to function properly. It will prompt for them if not provided at startup.


The foundational type for the documentation is the DocNode and is exported from the mod.ts.

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


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

# check version
$ rustc --version
rustc 1.56.0 (09c42c458 2021-10-18)

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

# test it
$ cargo test


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

deno_doc's People


kitsonk avatar bartlomieju avatar dsherret avatar lucacasonato avatar magurotuna avatar zhmushan avatar uki00a avatar Liamolucko avatar SeparateRecords avatar Aaron1011 avatar caspervonb avatar AnInternetTroll avatar satyarohith avatar peaceiris avatar kt3k avatar chansuke 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.