快速开始
本章节将引导你从零开始创建一个 VitePress 站点。
先决条件
- Node.js 版本 18 或更高版本。
- 终端(Terminal)和代码编辑器(如 VSCode)。
初始化项目
创建并进入新目录
bashmkdir my-vitepress-site cd my-vitepress-site初始化 npm 项目
bashnpm init -y安装 VitePress
bashnpm add -D vitepress运行初始化向导
VitePress 提供了一个方便的命令行工具来帮助你搭建基础结构。
bashnpx vitepress init该向导会提出几个问题,例如你的文档根目录、网站标题和描述等。根据你的需求回答即可。
项目结构
初始化完成后,你的项目结构大致如下:
.
├── docs
│ ├── .vitepress
│ │ └── config.js # 配置文件
│ ├── api-examples.md
│ ├── markdown-examples.md
│ └── index.md # 首页
└── package.jsondocs: 存放所有 Markdown 源文件和 VitePress 配置的地方。.vitepress: VitePress 的“心脏”,包含配置文件、主题和自定义组件。config.js: 站点的核心配置文件。
启动开发服务器
VitePress 在 package.json 中自动添加了一些脚本。
启动开发服务器
bashnpm run docs:dev访问站点
打开浏览器并访问命令行中显示的 URL(通常是
http://localhost:5173)。
现在,你应该能看到你的 VitePress 站点正在运行了!你对 docs 目录下的任何 .md 文件所做的更改,都会通过热模块重载(HMR)即时反映在浏览器中,无需刷新页面。
构建静态站点
当你准备好部署网站时,可以运行以下命令:
bash
npm run docs:build这会在 .vitepress/dist 目录下生成最终的静态文件,你可以将这个目录下的所有内容部署到任何静态托管服务上。