Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (docugen) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
docugen đ
An opinionated turbo-fast documentation generator âĄī¸
Motivation đ
Why docugen was created can be summarized in few short bullet points
- available documentation tools take too long to compile
- they use outdated module principles which can be trouble-some for modern apps
- the output format sucks
- you need to study in-depth a documentation of a documentation tool to even get remotely close to desired result
docugen aims to address all of these painpoints.
- built on top of bun (zig) APIs, it's blazing fast đĨ
- scans through file-system for modules, without need for any TS/JS compilation đ§
- built-in astro starlight integration for awesome format, with search and navigation included đ¨
- works with 0 config with sensible defaults, but still fully customizable with
cli commandsanddocugen.jsonconfiguration! đŊ
Installation & Usage âšī¸
You can use docugen as a one of script:
bunx docugenor install it as a devDependency
bun add -D docugen
bun run docugen