Butterfly 快速开始指南

Butterfly 是一个基于 hexo-theme-melody 开发的 Hexo 主题,提供了现代化的博客体验。

主题简介

hexo-theme-butterfly 是在 hexo-theme-melody 的基础上进行开发的主题。它提供了丰富的功能和美观的界面设计。

安装方式

方式一:Git 安装(推荐)

稳定版(建议使用)

在你的 Hexo 根目录下执行:

1
git clone -b master https://github.com/jerryc127/hexo-theme-butterfly.git themes/butterfly

测试版

如果想要安装较新的开发分支(可能存在 Bug):

1
git clone -b dev https://github.com/jerryc127/hexo-theme-butterfly.git themes/butterfly

升级方法:在主题目录下运行 git pull

方式二:npm 安装

此方法仅支持 Hexo 5.0.0 以上版本。

在你的 Hexo 根目录下执行:

1
npm install hexo-theme-butterfly

注意:通过 npm 安装不会在 themes 文件夹中生成主题文件夹,而是在 node_modules 中生成。

升级方法:在 Hexo 根目录下运行 npm update hexo-theme-butterfly

应用主题

修改 Hexo 根目录下的 _config.yml 文件,将主题改为 butterfly

1
theme: butterfly

安装必要的渲染器

如果你没有 pug 以及 stylus 的渲染器,请下载安装:

1
npm install hexo-renderer-pug hexo-renderer-stylus --save

升级建议

查看更新内容

升级完成后,请到 Github 的 Releases 页面查看新版本的更新内容。

页面中会标注 _config 文件的变更内容(如有),请根据实际情况更新你的配置内容。

使用独立配置文件(推荐)

为了减少升级主题后带来的不便,建议使用以下方法:

  1. 在 Hexo 的根目录创建一个文件 _config.butterfly.yml
  2. 将主题目录的 _config.yml 内容复制到 _config.butterfly.yml

重要注意事项:

  • 复制的是主题的 _config.yml,而不是 Hexo 的 _config.yml
  • 不要删除主题目录的 _config.yml
  • 以后只需要在 _config.butterfly.yml 中进行配置
  • 如果使用了 _config.butterfly.yml,配置主题的 _config.yml 将不会有效果

配置文件优先级

Hexo 会自动合并主题中的 _config.yml_config.butterfly.yml 中的配置。如果存在同名配置,会使用 _config.butterfly.yml 的配置,其优先度较高。

这样做的好处是:

  • 升级主题时,只需要更新主题文件夹中的文件
  • 你的自定义配置保存在 _config.butterfly.yml 中,不会被覆盖
  • 便于管理和维护配置

后续步骤

安装完成后,你可以:

  1. 查看主题页面配置指南,了解如何创建各种页面
  2. 学习主题配置选项,自定义你的博客
  3. 探索标签插件,丰富你的文章内容
  4. 查看常见问题解答,解决使用中的问题