@rxap/plugin-typedoc

A plugin for Nx workspaces to generate TypeDoc documentation. It provides executors and generators to easily integrate TypeDoc into your Nx projects. This plugin simplifies the process of creating and maintaining API documentation for your TypeScript libraries and applications.

• Installation
• Generators
  • init
  • init-library
  • init-application
• Executors
  • build

Installation

Add the package to your workspace:

yarn add @rxap/plugin-typedoc

Execute the init generator:

yarn nx g @rxap/plugin-typedoc:init

Generators

init

init generator

nx g @rxap/plugin-typedoc:init

Option	Type	Default	Description
project	string
projects	array
skipFormat	boolean	false
overwrite	boolean	false	Whether to overwrite existing files
skipProjects	boolean	false	Whether to skip executing project specific initialization

init-library

init-library generator

nx g @rxap/plugin-typedoc:init-library

Option	Type	Default	Description
project	string
projects	array
skipFormat	boolean	false
overwrite	boolean	false	Whether to overwrite existing files
skipProjects	boolean	false	Whether to skip executing project specific initialization

init-application

init-application generator

nx g @rxap/plugin-typedoc:init-application

Option	Type	Default	Description
project	string
projects	array
skipFormat	boolean	false
overwrite	boolean	false	Whether to overwrite existing files
skipProjects	boolean	false	Whether to skip executing project specific initialization

Executors

build

build executor

Option	Type	Default	Description
entryPoints	array
outputPaths	array
tsconfig	string
plugins	array
json	boolean
html	boolean
skipErrorChecking	boolean
markdown	boolean
wiki	boolean
includeVersion	boolean
entryPointStrategy	string