Interface CliArgs

the desired output directory for the generated docs. if a relative path is provided, then it will be resolved as a path relative to Deno's current working directory. (which is generally where deno.json resides.)

the path to your deno.json file for this project. if a relative path is provided, then it will be resolved as a path relative to Deno's current working directory. (which is also where deno.json generally resides.)

select logging level:

• false or "none": skip logging (dnt itself will still log).
• true or "basic": log what is being carried out at the top level.
• "verbose": in addition to basic logging, it also logs which files/folders are being copied or generated.
• undefined: unchange logging from previous state (which is "basic" by default).

enable dryrun if you wish for nothing to be written onto the the filesystem.

the root subpath in the website of the documentation (where the readme goes). for instance, if your domain name is "www.example.com", and your documentation's root should be at "www.example.com/docs/", then this option should be set to "docs/" (leading and trailing slashes will be trimmed, i.e. this option is invariant of them). if you leave this option undefined, then the script will use your "deno.json" configuration's "repository" key to parse the github-url, and then assign the site's root subpath to your repository's name, so that it is compatible with github-pages. otherwise, if no "repository" is present in your "deno.json", then an empty string ("") will be assigned, so that the webpage's root is also the documentation pages' root.

specify whether to preserve the intermediate temporary files created for document generation. the three temporary files that are generated for document generation, relative to "deno.json" directory are: package.json, tsconfig.json, and ./temp/custom.css.

a path to an docs-build configuration json file that provides additional modifiable parameters. see CliConfigJson for more details on the available extended configurations. in case there is a contradiction between the CliConfigJson setting and the current cli args, the cli arg will take precedence.