介绍
VuePress 是一个以 Markdown 为中心的静态网站生成器。你可以使用 Markdown来书写内容(如文档、博客等),然后 VuePress 会帮助你生成一个静态网站来展示它们。
VuePress 诞生的初衷是为了支持 Vue.js 及其子项目的文档需求,但是现在它已经在帮助大量用户构建他们的文档、博客和其他静态网站。
使用
-
创建并进入一个新目录
mkdir vuepress-starter cd vuepress-starter -
初始化项目
git init pnpm init -
将
VuePress安装为本地依赖pnpm add -D vuepress@next @vuepress/client@next vue -
在
package.json中添加一些scripts{ "scripts": { "docs:dev": "vuepress dev docs", "docs:build": "vuepress build docs" } } -
将默认的临时目录和缓存目录添加到
.gitignore文件中echo 'node_modules' >> .gitignore echo '.temp' >> .gitignore echo '.cache' >> .gitignore -
创建你的第一篇文档
mkdir docs echo '# Hello VuePress' > docs/README.md -
在本地启动服务器来开发你的文档网络
pnpm docs:dev
VuePress 会在本地启动一个热重载的开发服务器。当你修改你的 Markdown 文件时,浏览器中的内容也会自动更新。
现在,你应该已经有了一个简单可用的 VuePress 文档网站。
乱码问题
按照上面的方法访问本地浏览器打开后如果出现乱码问题
需要把md文档的编码格式改为 utf-8
我的方法个人觉得比较麻烦:先用记事本打开md文档》左上角另存为》选择编码格式》utf-8》确认就好了》记得把名称替换
有更好的解决办法请在评论区告诉我,谢谢