搭建一个属于自己的文档站


因为最近都在准备实习,所以我想整理一下面试笔记,但是我习惯使用markdown格式,而且我想做成vue的官方文那样的,所以我就在网上找,最后找到一个vuepress的东西。然后还找到一个不错的主题。

最终效果如下:面试问题浓缩总结 (xiaoyou66.com)

先给大家看看效果图

怎么样,很好看不?下面我们来搭建一下。

下载源码

代码地址:xugaoyi/vuepress-theme-vdoing: 🚀一款简洁高效的VuePress知识管理&博客(blog)主题 (github.com)

如果看官方文档的也可以跳转:快速上手 | vuepress-theme-vdoing (xugaoyi.github.io)

运行项目

我们先npm install然后在npm run dev执行后效果如下

然后我们就可以删除不需要的代码了,首先删除文章,下面这些都可以删除

注意,官方文档说了,我们创建目录时必须要编序号,文件夹和文档都需要编号,详细参考:

构建结构化站点的核心配置和约定 | vuepress-theme-vdoing (xugaoyi.github.io)

然后就是页面的设置了,我们先自己创建自己的项目结构,比如我这里是这样的

然后我可以自己重新运行一下,然后我们的markdown文档就会多出一些代码

我们记下这个地址,然后我们配置一下顶部导航栏,如下

修改这个文件,就可以自定义导航栏了

然后就是删除不需要的插件,不需要的插件自己直接删除就可以了

其他的细节配置,里面其实说的很详细了,自己按照里面的要求自己修改即可

我们也可以修改网站标题

注意:如果自己嫌官方的demo麻烦可以直接克隆我的仓库,在我的基础上进行修改

添加到github page

修改好后,我们就可以部署到github page上了,官方文档也有相关教程

部署 | vuepress-theme-vdoing (xugaoyi.github.io)

我们可以使用action,每次我们推送镜像后github就自动编译生成静态文件

我们先按照官方文档创建个人访问令牌 - GitHub Docs生成一个令牌,然后把自己到仓库的设置里面配置环境变量

配置好后我们修改一下bash脚本

最后把代码推送到github上去,推送后我们就可以看到action启动了,然后里面的部署脚本会自动构建,并新建一个分支

这个就是我们的分支了,这些静态文件就是action 自动生成的

然后我们设置一下github page

域名解析

我们到域名解析哪里,把我们自己的域名解析到github page,我们添加 cname解析,然后记录值就填github的那个地址(注意修改用户名为自己的)

最后我们就可以访问了


文章作者: 小游
版权声明: 本博客所有文章除特別声明外,均采用 CC BY 4.0 许可协议。转载请注明来源 小游 !
  目录