Using vitepress-jsdoc as a Command Line Tool ​

For those who prefer the command line, this section will cover how to use vitepress-jsdoc as a standalone CLI tool, offering flexibility in your documentation generation process.

Basic Command ​

To use vitepress-jsdoc from the command line, you can utilize the following basic command:

npx vitepress-jsdoc --source path/to/dist/esm --dist ./docs --folder code  --readme path/to/README.md --exclude=\"**/*.json,**/*.hbs,**/*.d.ts,**/*.map,**/interfaces.*\" --partials=path/to/handlebars/partials/*.hbs --helpers=path/to/handlebars/helpers/*.hbs

npx vitepress-jsdoc --source path/to/dist/esm --dist ./docs --folder code  --readme path/to/README.md --exclude=\"**/*.json,**/*.hbs,**/*.d.ts,**/*.map,**/interfaces.*\" --partials=path/to/handlebars/partials/*.hbs --helpers=path/to/handlebars/helpers/*.hbs

This will run vitepress-jsdoc with default settings.

Specifying Options ​

You can also specify various options to customize the documentation generation process. Here's an example:

npx vitepress-jsdoc --source ./src --dist ./docs --folder code --title API

npx vitepress-jsdoc --source ./src --dist ./docs --folder code --title API

In this example:

• --source ./src: Specifies the source directory containing your code.
• --dist ./docs: Specifies the destination directory where the generated documentation will be saved.
• --folder code: Sets the folder name for the documentation.
• --title API: Sets the title of your documentation.

Additional Options ​

There are several other options available to further customize the documentation generation process, such as specifying partial templates, helper scripts, custom README, and excluding specific files or folders. Refer to the vitepress-jsdoc readme for a comprehensive list of available options.

By using vitepress-jsdoc as a CLI tool, you have the flexibility to generate documentation as needed, without the need for a full Vitepress setup.