快速上手

环境准备

兼容性注意

Vite 需要 Node.js 版本 14.18+，16+。然而，有些模板需要依赖更高的 Node 版本才能正常运行，当你的包管理器发出警告时，请注意升级你的 Node 版本。

你可以直接使用 vitdoc-template 进行仓库初始化，访问 https://github.com/vitdocjs/vitdoc-template 了解更多。

该模板中已经为你提供一些组件和文档用法，完成初始化后即可按照以下步骤进行开发：

bash

$ npm i
$ npm run dev

bash

cd vitdoc-starter

bash

yarn add -D vitdoc

json

{
  "scripts": {
    "docs:dev": "vitdoc",
    "docs:build": "vitdoc build"
  }
}

bash

mkdir components
echo '# Hello Vitdoc' > components/README.md

bash

yarn docs:dev