@discordoo/tapok v2.0.26

Discordoo documentation generator (generates json file)

Big thanks

to Federico Grandi. The author of this package. This repository is based on this person's code. Sponsor Federico Grandi.

Usage

$ tapok path/to/typedoc-result.json
$ tapok path/to/markdown-contents-file.json

Flags

--config -c     string    typedoc config (like typedoc.json)
--entry -e      string    typedoc entry point (used in typedoc --entry)
--markdown -m   boolean   switch to markdown files processing
--directory -d  string    directory where read markdown files
--include -i    string    include non-exported types or not

Examples

$ tapok ./docs.json -c ./typedoc-config.json -e typedoc/entry/point.ts
# ┗ will generate docs.json using typedoc and then will replace result with ddoo-compatible json file.
$ tapok ./markdown.json -m -d ./docs
# ┗ will generate markdown.json that contains array of markdown files from docs directory