Skip to main content

Generate README.md from jsdoc @module. It uses `deno doc --json` to get the needed informations.

Works with
This package works with Deno
JSR Score
100%
Published
3 months ago (1.0.3)

Doc Gen

Generate README.md from jsdoc @module

It uses deno doc --json to get the needed informations

Usage

By default its outputs to stdout

deno run -A jsr:@sigmasd/doc-gen entrypoint.ts

If you want to create/update README.md you can use shell redirection

deno run -A jsr:@sigmasd/doc-gen entrypoint.ts > README.md

Or add a convenience task in deno.json

"tasks": {
  "doc": "deno run -A jsr:@sigmasd/doc-gen ./entrypoint.ts > README.md"
}
Built and signed on
GitHub Actions
View transparency log

Add Package

deno add @sigmasd/doc-gen

Import symbol

import * as mod from "@sigmasd/doc-gen";