type
status
date
slug
summary
tags
category
icon
password
Property
May 10, 2025 05:07 PM
安装
依赖环境
提示
- 使用 yarn 2+在新窗口打开 时,你需要在
.yarnrc.yml
在新窗口打开 文件中设置nodeLinker: 'node-modules'
。
创建项目
通过命令行创建
你可以通过 create-vuepress在新窗口打开 直接创建项目模板。
手动创建
这一章节会帮助你从头搭建一个简单的 VuePress 文档网站。
- 创建并进入一个新目录
- 初始化项目
- 安装 VuePress
- 创建
docs
目录和docs/.vuepress
目录
- 创建 VuePress 配置文件
docs/.vuepress/config.js
- 创建你的第一篇文档
目录结构
创建完成后,你项目的目录结构应该是这样的:
docs
目录是你放置 Markdown 文件的地方,它同时也会作为 VuePress 的源文件目录。docs/.vuepress
目录,即源文件目录下的 .vuepress
目录,是放置所有和 VuePress 相关的文件的地方。当前这里只有一个配置文件。默认还会在该目录下生成临时文件、缓存文件和构建输出文件。建议你把它们添加到 .gitignore
文件中。示例 `.gitignore` 文件
开始使用 VuePress
启动开发服务器
运行
docs:dev
脚本可以启动开发服务器:VuePress 会在 http://localhost:8080在新窗口打开 启动一个热重载的开发服务器。当你修改你的 Markdown 文件时,浏览器中的内容也会自动更新。
构建你的网站
运行
docs:build
脚本可以构建你的网站:在
docs/.vuepress/dist
目录中可以找到构建生成的静态文件。你可以查看 部署 来了解如何部署你的网站。