jsdoc2vitepress

Generates vitepress API documentation from jsdoc annotated source code.

What you need is to write comments that conform to the jsdoc specification, and jsdoc2vitepress will help you generate API documentation by VitePress.

Install

npm install -D jsdoc2vitepress

Usage

Init docs directory

jsdoc2vitepress init 

What will happen?

In local Directory

Start VitePress

Generates vitepress API documentation from jsdoc annotated source code and run Vitepress

jsdoc2vitepress start

What will happen?

In console

In local Directory

In Once of the Markdown

Build VitePress

Generates vitepress API documentation from jsdoc annotated source code and build Vitepress

jsdoc2vitepress build

What will happen?

In console

In local Directory

Website

How it work

JS/TS annotated source code -> Markdown ->VitePress website

See More detail in 注释生成文档太难看？试试用注释生成vitepress文档

License

MIT

Copyright (c) 2022-present, luciozhang