通过github pages部署vitepress前端静态文档

463 阅读1分钟

1.将vitepress项目打包

这是vitepress项目

image.png

在packages.json中添加命令,在build之后跑"docs:preview": "vitepress preview"命令,如果能正常跑起来就可以开始部署了。

 "scripts": {
    "dev": "vitepress dev .",
    "docs:build": "vitepress build",
    "docs:preview": "vitepress preview"
  },

这是我打包后的结构

image.png

2.创建一个github仓库

把打包后的dist文件夹传到仓库,点击和code同一列的setting,然后在左侧导航栏找到pages

image.png

之后在这里选择提交的分支,我用的是main下的root

image.png

点击save稍等一会,刷新一下pages页顶部就会出现网页链接,在部署时可以切到code页面查看部署的日志状态。

3.注意事项

  • base的配置:在config.mts中需要配置base保证部署不会出错,base设置为/你的仓库名/
  • 网页favicon.ico的路径设置:我一开始使用相对路径部署后tab图标无法显示,如果无法显示的话需要改成绝对路径