this is a cli tool for generating a documentation site for your deno project, using typedoc under the hood.
this tool reads your "deno.json" file and generates a equivalent "package.json" and "tsconfig.json" files, which can then be used by TypeDoc for generating the documentation site's html files.
this tool comes with a handful of useful preset configurations, so that you won't have to write lengthy cli args.
take a look at CliArgs and CliConfigJson to see what configuration options are available.
moreover, to use this document generator via javascript instead of the shell, use the buildDocs function from the docs.ts file (or jsr:@oazmi/build-tools/docs if using jsr).
this is a cli tool for generating a documentation site for your deno project, using
typedoc
under the hood.this tool reads your "deno.json" file and generates a equivalent "package.json" and "tsconfig.json" files, which can then be used by
TypeDoc
for generating the documentation site's html files. this tool comes with a handful of useful preset configurations, so that you won't have to write lengthy cli args.take a look at CliArgs and CliConfigJson to see what configuration options are available.
moreover, to use this document generator via javascript instead of the shell, use the buildDocs function from the
docs.ts
file (orjsr:@oazmi/build-tools/docs
if using jsr).