Skip to content

快速上手

推啊文档中心汇总内部与生态相关库的文档入口,方便统一查阅。

文档结构

类型说明
外链文档有独立文档站的库(如 thooks、组件库等),侧边栏点击即在新标签页打开
本库文档无独立站点的小型 npm 包,文档写在本站,在侧边栏「本库文档」下列出

完整列表见 库总览

如何查阅

  1. 点击顶部 或侧边栏 库总览 进入
  2. 在「外链文档」或「本库文档」中点击目标库即可。

如何新增文档

新增外链

  1. 打开 .vitepress/config.mts,在「外链文档」的 items 中增加一项,例如:
    { text: 'xx 组件库', link: 'https://...', target: '_blank' }
  2. 打开 libs.md,在「外链文档」表格中追加一行。

新增本库文档

  1. doc/libs/ 下新建 包名.md(如 xxx-utils.md)。
  2. .vitepress/config.mts 的「本库文档」items 中增加:
    { text: 'xxx-utils', link: '/libs/xxx-utils' }
  3. libs.md 的「本库文档」表格中登记该包。