@sigmasd/doc-gen@2.0.0
Built and signed on GitHub Actions
Built and signed on GitHub Actions

latest

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

Published

8 months ago (2.0.0)

Doc Gen

Generate README.md from jsdoc @module

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

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 && deno fmt README.md"
}

Built and signed on

GitHub Actions

Add Package

deno add jsr:@sigmasd/doc-gen

Import symbol

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

Import directly with a jsr specifier

import * as doc_gen from "jsr:@sigmasd/doc-gen";