主题
当我们开发了一个命令,或者在packages目录下添加或修改了代码包里面的一些功能,就需要维护相关的说明文档。
命令
packages
进入项目根目录,并执行以下命令启动文档服务:
根目录
pnpm run docs:dev
这将启动文档开发服务器http://localhost:5172/,让你能够实时预览写好的文档。
http://localhost:5172/
命令文档可以自动生成,packages目录下的代码包可以根据typescript类型和代码注释自动生成文档,具体使用方式可以查看文档自动生成说明。
文档自动生成
文档服务基于vitepress开发,请直接访问vitepress官方站点获取开发文档。
vitepress