大道至简:快速搭建博客与文档站点的终极指南2.0
本文最后更新于:10 天前
破冰
对Gitee进行简介,介绍其作为开源托管平台的优势和受欢迎程度
提出使用Gitee来托管静态网站的需求和好处
思维碰撞
云服务器部署 Hexo 博客
2024年5月7日
上上周六下午突然发现 Gitee Pages 失效了,等了快半个月官方仍没有发任何公告或通知。今天看到消息,估计官方计划关闭个人账户下的 Gitee Pages 服务,只保留企业版的。
我是不能坐以待毙了,赶紧学一学如何部署 Hexo 博客网站到云服务器上,正好去年十一月份买的阿里云服务器闲置着没地方用呢。
Hexo 博客搭建并发布到云服务器 - 我如云影君如梦 - 博客园 (cnblogs.com)
在云服务器上搭建hexo博客(亲测可用) - 菲尼克斯交警 - 博客园 (cnblogs.com)
Hexo部署到云服务器 - 简书 (jianshu.com)
Nginx 启动报错,卸载重新安装还是一样。
Linux启动nginx失败_linux nginx 无法启动-CSDN博客
1 |
|
1 |
|
奇了怪了,端口未被占用,配置文件也无误,为什么还是启动不了呢,我越发觉得有意思起来了。
诶?
突然显示服务器连接失败,我又重新远程登录进来:依次执行五步操作:
1 |
|
1 |
|
1 |
|
1 |
|
1 |
|
执行完这五步,在此查看 Nginx 状态,发现竟然启动成功了。
有点奇怪,难道是这个服务器太久没用了,需要时间磨合嘛。不管怎么说,Nginx 起来了,今天晚上回去研究下怎么用云服务器部署个人博客网站。
Github 部署 Hexo 博客
测试 Github 是否能正常网络连接:
1 |
|
ssh -T git@github kex_exchange_identification: Connection closed by remote host-CSDN博客
Github备份代码出现kex_exchange_identification: Connection closed by remote host - 知乎 (zhihu.com)
Vuepress 文档站点 部署
🔥 推荐阅读:(2023/11/28晚)
- vuepress打包部署到Gitee Pages访问页面出现样式丢失_De Ja Vu 幻觉记忆的博客-CSDN博客
- Getting Started | VuePress (vuejs.org)
- VuePress起步 - VuePress中文网 (caibaojian.com)
- 快速上手 | VuePress (vuejs.org)
快速搭建
- 哎,全局安装 Vuepress 不支持了,本来挺好用的:
1 |
|
- 直接在 Github 下载了官方文档源码,呃,还是局部安装吧
- 拉取代码后执行依次以下命令,即可成功在本地部署文档站点:
1 |
|
- 效果如下:
- 这两天在研究这个 Vuepress,感觉比 VitePress 更成熟、更好用
- 等我把局部安装的配置搞清楚之后,再来此处作详细记录(2023/11/27晚)
配置详解
侧边栏配置
- 这里着重详解下 Vuepress 文档站点的侧边栏配置,官方文档在这方面的编写实在是有点含糊不清 (2023/12/06晚)
- 不同页面显示不同的侧边栏
- 侧边栏分组
- 分组可折叠???
- 侧边栏展示标题深度
- 两个全局配置:活动标题链接(默认开启)和展开所有标题链接(默认关闭)
- 自动生成侧边栏:.js 配置方式 + .md 配置方式,后者更灵活,能配置标题
- 禁用侧边栏
其他
这里先回答之前的两个傻逼的问题:(2023/12/06晚)
🤡 选中导航栏后,默认为第一个子文件,也就是说,导航栏下没有默认 README.md 页面
- 这是什么意思呢?就是这个意思:
- 这不就很简单?配置好导航栏菜单的跳转就可以了:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23nav: [
{ text: "首页", link: "/" },
{
text: "指南",
link: "/pages/52d5c3/",
items: [
{ text: "简介", link: "/pages/52d5c3/" },
{ text: "安装", link: "/pages/a2f161/" },
{ text: "快速开始", link: "/pages/793dcb/" },
{ text: "返回响应码", link: "/pages/2f674a/" },
{
text: "API接口",
items: [
{ text: "随机壁纸", link: "/pages/8dfab5/" },
{ text: "随机名言", link: "/pages/dd027d/" },
{ text: "天气查询", link: "/pages/2b8e22/" },
{ text: "获取IP信息归属地", link: "/pages/0fc1d2/" },
],
},
],
},
.......................
],🤡 显示文章的右侧目录
- 大哥,想什么呢,官网文档都没实现呢,不过有插件可以实现,没有成功过:vuepress右侧小目录 二级目录 右侧锚点 模拟Docusaurus效果 - 丁少华 - 博客园 (cnblogs.com)
- 要想做个右侧目录,那就使用
Vdoing
吧
Gitee 部署
- 部署之前肯定要有 Gitee 远程仓库吧,创建一个新仓库,这里新仓库名就叫
VuepressDocs3
了(2023/11/28晚)
- 在
.vuepress/config.js
下,作如下配置:
1 |
|
这里注意,base 的值对应的是将要部署的 Gitee 仓库地址,看清楚上面新仓库的地址:
vuepress-docs3
执行以下命令,打包:
1 |
|
- 然后你就会神奇的发现,.vuepress 目录下多了一个 dist 文件夹,这就是打包好的静态网站文件了
- 把
dist
下的文件远程推送到指定 Gitee 远程仓库中,开启 GiteePages 服务:
- 大功告成,直接访问即可:Mem-API 开发者文档 (gitee.io)
踩坑记录
- 踩过的坑算很多了,这里一并提一下:(2023/11/28晚)
2023/11/26晚
了解到了 Vuepress 的
全局安装
(不支持了)、局部安装
和直接通过第三方主题安装
,并了解了相关配置总结来讲,这晚尝试了下 Vuepress 站点的简单配置,还没开始部署
妈的,搞了一晚上 Vuepress ,好像没啥成果,但我总得记录一些东西吧:
部署 Vuepress 文档站点:原生(全局安装、局部安装) / 第三方主题
局部安装,好多东西还得自己配置,我哪来的闲心
全局安装的话,他奶奶的,执行命令还不起作用
第三方主题,感觉很不亲切
尝试部署 Github,大体上成功了,但是打包完成后执有问题,现在本地部署也出现问题了
2023/11/27晚
- 也就睡前半个多小时,简单地搞了搞,发现在 Github 上可以直接拉官方代码,实现全局安装
🚀 下载地址:vuejs/vuepress at v1.9.10 (github.com)
- 还想着在这个基础上修修改改,做个文档站点,不过真的复杂,看看了解即可,在这个基础上做改动太不实际了,直接劝退
- 那就用前天晚上的成果,直接着手部署了:Github / Gitee
🍻 推荐阅读:vuepress打包部署到Gitee Pages访问页面出现样式丢失_De Ja Vu 幻觉记忆的博客-CSDN博客
- Github 不想多说,太他妈吃网速了,访问慢不说,好不容易推送成功,还老是显示部署失败,发了十几条邮箱信息都没咋注意:
- 呐,上面就是 Github Pages 服务了,太卡了,部署不了,不过网速好的话是没有问题的(2023/11/28晚)
Vdoing 文档站点 部署
快速搭建
- 拉取官方 demo(2023/12/06晚)
- 如下,直接按照官方文档的步骤,拉取官方文档站点预设 demo(这一步不用作过多详细解释了,看官方文档就行):
- 拉取成功,简单看一下目录结构(官网提供),最重要的配置文件就是
docs/.vuepress/config.js
配置文件了:
1 |
|
简单修改配置:
基本上所有配置官方都已经替我们做好了,我们要做的仅仅是改改
网站标题
、导航栏
、侧边栏
,然后把博文替换成自己的就行简单甩出我的配置,仅供参考,详细的配置这里不作过多介绍,需要靠自己慢慢摸索(2023/12/06晚)
1 |
|
Gitee 部署
- 部署流程跟上面 Vuepress 文档站点部署是一样样的:
配置远程仓库地址 -> 打包 -> 推送至远程仓库 -> 开启 Gitee Pages 服务
值得注意的是,不论是执行
yarn dev
还是yarn build
,都会有这样的友好提示(这也是和 Vuepress 不同的地方):按提示修改就行
踩坑记录
- 一晚上遇到好些个坑,在
config.js
配置文件中指定base
路径并打包完成后,在dist
目录下执行以下命令:
1 |
|
- 结果是这样(样式丢失):(2023/12/06晚)
这样是正常的,在推送
dist
目录下的文件到远程仓库的过程中,由于对 git 命令的不熟悉,一直被之前的提交记录所影响建议直接把打包后生成的
dist
目录剪切在一个干净的目录下,执行推送推送成功:
- 开启
Gitee Pages
服务成功后,直接访问:(2023/12/06晚)
Vdoing 主题搭建文档站点
Memory Tools
- 今日,
Memory-Tools 开发者文档
基本完成!效果如下:(2032/12/19午)
- 查看详情,可点击跳转:Memory-Tools 开发者文档
MemorySearch 忆搜阁
今日,基本完成 MemorySearch 忆搜阁
的文档编写和网站首页制作!
网站首页使用 vuepress-theme-hope 主题:
开发文档使用 vdoing 主题:
使用 vdoing 主题搭建的 Vuepress 文档中,在 config.js
和 index.md
文件中,可分别修改文档首页 LOGO
和 导航栏 LOGO
:
1 |
|
1 |
|
严重问题
2024年4月29日
基础知识
Gitee基础知识和使用
- 注册和创建Gitee账号
- 创建新的仓库(Repository)
- 了解仓库的组成和功能,例如分支、提交记录等
- 熟悉仓库的基础操作,如上传和下载文件、提交和同步代码等
Gitee Page服务简介
- 介绍Gitee的Page服务,它是什么以及它的作用
- 解释Page服务的原理和运行机制
- 简要介绍Page服务的特性,如自动部署、自定义域名等
托管静态网站的步骤和实践
- 准备网站目录和静态资源
- 在Gitee仓库中创建和组织网站文件的结构
- 配置Page服务并将网站部署到Gitee仓库
- 详细说明自定义域名、HTTPS等高级配置选项
最佳实践和常见问题解答
- 分享一些使用Gitee托管静态网站的最佳实践和技巧
- 解答常见问题,如如何自动构建、如何更新网站内容等
Gitee托管
总结
- 总结使用Gitee的Page服务托管静态网站的优势和便利性
- 强调Gitee作为开源社区的重要性,并鼓励读者尝试使用Gitee进行项目和网站托管