quickdoks

quickdoks

A cli tool that auto generates documentation from your JavaScript or TypeScript project by utilizing TSDoc or JSDoc comments.

WARNING: This project is at a really early stage and currently under heavy development. It is not feature complete and it may not or only partially work with your project. You have been warned.

Installation

npm i quickdoks

Usage

quickdoks generate <path/to/entry-file.ts> [options]

Options

--output <path/to/output/file-name>     # Specify the output directory and file-
-o <path/to/output/file-name>           # name. Defaults to ./docs/api based on
                                        # the current working directory.

--tsconfig <path/to/tsconfig.json>      # Provide a tsconfig file used to
-t <path/to/tsconfig.json>              # compile your project. quickdoks will
                                        # try to find the tsconfig by itself if
                                        # no tsconfig.json is provided.

--config <path/to/.quickdoks.json>      # Provide a quickdoks config used to
-c <path/to/.quickdoks.json>            # render the documentation. quickdoks
                                        # will try to find the .quickdoks.json
                                        # config by itself if none is provided
                                        # or uses the default config.

--renderer <markdown | html>            # Choose the format of the rendered 
-r <markdown | html>                    # output. Defaults to markdown.

--silent                                # Disables the output.
-s

--version                               # Returns the installed quickdoks
-v                                      # version.

Configuration

You can configure how your documentation will be rendered using a configuration file. The simplest way to create such a configuration file is by using the following command:

quickdoks init

This will create a .quickdoks.json file in the current working directory with the default configuration. You can change or remove any of the options in the configuration file.