denoland/deno_doc ↗
Created Apr 24, 2022 · View the denoland/deno_doc repository page
Documentation generator for Deno
Want this for your repo?
Render a free sample of any GitHub repo in seconds.
Contributors
19
Lines of Code
697
From
Aug 18, 2020
To
Apr 8, 2022
About denoland/deno_doc
`deno_doc` is a Rust crate that generates documentation for JavaScript and TypeScript modules. While it powers the `deno doc` command-line tool, it's designed to be runtime-agnostic and can be used to build documentation generators for Node.js, browsers, or other JavaScript environments.
The crate handles the full documentation generation pipeline, including parsing JavaScript and TypeScript modules, extracting documentation metadata, rendering HTML output with styled pages, and supporting interactive features like property drilldown for classes and interfaces. It uses Tailwind CSS for styling and includes a pluggable markdown rendering system with a default implementation via the `comrak` crate. The HTML generation is template-based and organized into discrete components for different symbol types and page structures.
The project emphasizes developer experience with convenient task commands for local development, including tools for CSS transpilation, HTML generation, and snapshot testing via the `insta` crate. Contributors can iterate quickly on HTML rendering and styling without full recompilation, and comprehensive integration tests ensure that changes to output rendering are captured and reviewed intentionally.
