Hexo 博客添加 README.md 以及部署到 GitHub 丢失/显示不正常解决方法


GitHub 项目的README.md为自述文件,可对该项目进行介绍,解释等。

使用 Github Pages 和 Hexo 搭建的博客,如果在最开始建立仓库的时候没有创建README.md文件,那么在后期如何添加呢?

添加方法:在根目录 source 文件夹下新建README.md即可,该文件使用 Markdown 语法。

然而当我们执行 hexo g -d 部署博客的时候会发现README.md变成了 README.html,如下所示:
在这里插入图片描述
原因就在于当我们在执行 hexo g -d 命令时,.md 文件会被转化成 HTML 文件,并将这些文件放到 public 目录里,最后再提交到远程 GitHub 仓库,而 Hexo 也提供了一个方法,让md文件不被转换成HTML,在根目录的 _config.yml 配置文件里,找到 skip_render 关键字,添加 README.md,让解释器跳过渲染就行了:

skip_render: README.md

官方文档:https://hexo.io/docs/configuration
拓展阅读:《Hexo + Github Pages 自定义一个不使用主题模板渲染的独立页面》
我的博客:https://www.itbob.cn/

### 如何将 Hexo 博客部署GitHub Pages #### 安装必要的插件 为了能够顺利地将 Hexo 博客部署GitHub Pages,需安装 `hexo-deployer-git` 插件。这可以通过执行如下命令完成: ```bash npm install hexo-deployer-git --save ``` 此操作会下载并配置好用于连接本地项目与远程 Git 仓库所需的组件[^1]。 #### 准备工作 确保已拥有一个 GitHub 账户以及创建了一个新的仓库来存储博客文件。注意,在初始化新库时应选择 **Initialize this repository with a README** 来避免后续推送过程中遇到冲突问题[^4]。 #### 修改 `_config.yml` 文件中的设置 找到位于根目录下的 `_config.yml` 文件,并编辑其中关于部署的部分以匹配个人的 GitHub 用户名和仓库名称。具体来说就是更新如下字段: ```yaml deploy: type: git repo: https://github.com/USERNAME/REPO.git branch: main ``` 这里的 `repo:` 后面应该填写完整的 SSH 或 HTTPS URL 地址指向所建立的那个私有或公开性质的 GitHub Repository[^2]。 #### 执行部署流程 当一切准备就绪之后,可以按照下面给出的一系列指令来进行最终的数据同步动作: ```bash hexo clean # 清除缓存文件 (db.json) 和已生成的静态文件 (public) hexo generate # 将 Markdown 文章转换成 HTML 页面 hexo deploy # 把最新版的内容推送到指定分支上 ``` 上述每一步骤都至关重要,因为它们共同构成了从撰写博文到最后上线展示给读者看的关键环节。 值得注意的是,Git 是一种分布式版本控制系统,而 GitHub 则是一个基于 Web 的平台,它提供了托管服务使得开发者们能更方便地管理和分享自己的代码资源。因此理解两者之间的区别对于成功搭建在线博客非常重要[^3]。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

WuKongSecurity@BOB

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值