Integration of TypeDoc's Rspress Plugin for Automatically Generating API Documentation for TS Modules.
When you start/build the project, the plugin will automatically generate an api
directory in your document root directory. The directory structure is as follows:
This means that the plugin will internally call TypeDoc to automatically generate API documentation for your modules, including module lists, Interface
details, function details (parameters, return values, description), etc. It will also generate a documentation.json
file for subsequent sidebar rendering.
Note that the documentation is regenerated every time you start the project to reflect the latest module content. Therefore, we recommend adding the api
directory to .gitignore
. If you customize the output directory with the outDir
parameter below, you should also add it to .gitignore
.
Also, we do not recommend modifying or adding documents in the api
directory because these documents will be overwritten each time the project is started due to changes in module content.
string[]
[]
Specifies the absolute path of the TS modules for which documentation should be generated.
string
api
Customize the output directory for the documentation. You need to provide a relative path, such as api/custom
.