Hexo + Butterfly

为 Hexo 博客接入 Butterfly 主题与 Pug、Stylus 渲染能力

Hexo承载博客,Butterfly提供主题,Pug和Stylus负责主题模板与样式渲染。

✓ 响应式设计适配多种屏幕✓ 集成搜索、评论与数据分析 ✕ NPM安装仅支持 Hexo 5.0.0及

方案简介

这是一个以 Hexo 为基础、接入 Butterfly 主题的现代化博客方案。它通过主题配置和配套渲染器,把 Hexo 的文章发布能力扩展为具有卡片化布局、响应式界面、深色模式、目录导航、搜索、评论、统计和多种视觉效果的内容站点。方案适合已经使用 Hexo,或希望快速搭建个人博客、技术博客与内容展示站点的用户。\n\nButterfly 本身是适用于 Hexo 的主题,安装位置位于博客根目录的 themes/butterfly,也可以通过 NPM 安装。主题启用后,再根据需要安装 Pug 与 Stylus 渲染器,即可形成从 Hexo 内容生成到主题页面渲染的完整链路。

亮点与能力

方案提供的主要能力包括:\n\n- 卡片化设计、圆角或直角边框、双栏布局与响应式适配。\n- 深色模式,适合夜间阅读。\n- 多级菜单、阅读模式、电脑和手机双端 TOC、字数统计与阅读时间。\n- 相关文章推荐、文章过期提醒、简繁中文切换和标签外挂。\n- Algolia、本地搜索与 Docsearch,多种搜索方式,并提供内建 404 页面。\n- Pjax 页面切换、代码语法高亮、代码语言显示、折叠展开、复制按钮与自动换行。\n- Mathjax、Katex、Mermaid、Chart.js 与 ABCJS 等内容表达能力。\n- Disqus、Gitalk、Valine、Waline、Twikoo、Giscus、Artalk 等评论系统,并支持同时启用两套评论系统。\n- 分享、在线客服、访问统计、网站分析、站长验证、广告位、PWA、图片灯箱与懒加载。

组成与分工

  • Hexo:作为博客生成框架和站点根目录,承载文章、页面及主题配置。README 的安装步骤要求在 Hexo 博客根目录执行主题安装。\n- Butterfly:作为站点主题,提供整体视觉设计、页面布局、导航、文章展示、搜索、评论和扩展功能。\n- Pug:作为主题所需的渲染器之一,参与模板渲染。\n- Stylus:作为主题所需的渲染器之一,参与样式渲染。\n- Git:用于从 GitHub 获取稳定版或开发版主题,并将代码放入 themes/butterfly。\n- NPM:用于安装 Butterfly 主题以及 Pug、Stylus 渲染器;NPM 方式有 Hexo 版本要求。

前置要求

开始前需要准备一个 Hexo 博客根目录。若采用 NPM 安装方式,项目明确要求 Hexo 5.0.0 及以上版本;若采用 Git 安装方式,则可按文档将主题克隆到 themes/butterfly。\n\n主题渲染还需要 Pug 与 Stylus 渲染器。如果博客尚未安装这两个依赖,应在博客根目录执行:\n\n``bash\nnpm install hexo-renderer-pug hexo-renderer-stylus --save\n`\n\n也可以选择通过 NPM 安装主题:\n\n`bash\nnpm install hexo-theme-butterfly\n``

实施步骤

1. 进入 Hexo 博客根目录\n\n在已有的 Hexo 博客根目录中执行后续安装操作。主题安装命令必须在该目录执行,因为 Git 方式会把主题放入 themes/butterfly。\n\n### 2. 安装 Butterfly 稳定版\n\n推荐使用 master 分支安装稳定版本:\n\n``bash\n# 安裝穩定版本(推薦)\ngit clone -b master https://github.com/jerryc127/hexo-theme-butterfly.git themes/butterfly\n`\n\n如果需要抢先体验开发中的功能,也可以使用 dev 分支:\n\n`bash\n# 安裝開發版本(搶先體驗新功能)\ngit clone -b dev https://github.com/jerryc127/hexo-theme-butterfly.git themes/butterfly\n`\n\nGit 安装与 NPM 安装是两种安装方式,应根据项目实际维护方式选择其一。NPM 方式的命令为:\n\n`bash\nnpm install hexo-theme-butterfly\n`\n\n### 3. 安装主题渲染依赖\n\n如果当前博客没有 Pug 和 Stylus 渲染器,在根目录执行:\n\n`bash\nnpm install hexo-renderer-pug hexo-renderer-stylus --save\n`\n\n### 4. 启用主题\n\n修改 Hexo 配置文件 _config.yml,将主题设置为 Butterfly:\n\n`yaml\ntheme: butterfly\n``\n\n保存配置后,Hexo 才会在生成站点时使用 Butterfly,而不是继续使用原主题。\n\n### 5. 检查主题页面\n\n完成安装、依赖补齐和配置修改后,使用现有 Hexo 工作流生成并预览博客。检查首页、文章页、目录、主题布局以及配置中启用的扩展功能是否正常显示。

使用与配置要点

启用后,日常使用仍以 Hexo 博客内容管理为中心,主题能力通过 _config.yml 及 Butterfly 的主题配置进行调整。建议先确认基础页面可以正常生成,再逐项开启搜索、评论、统计、分享和视觉效果等功能。\n\n页面验证可以按以下顺序进行:\n\n- 打开首页和文章页,确认卡片化布局、双栏布局和响应式表现正常。\n- 在桌面与移动端检查 TOC、菜单、阅读模式和深色模式。\n- 检查代码块是否支持语法高亮、语言显示、复制和折叠。\n- 若使用数学公式,验证 Mathjax 或 Katex 内容;若使用图表,验证 Mermaid 或 Chart.js 内容。\n- 按需配置评论系统、分享套件、在线客服、统计服务和广告位,并逐项确认第三方服务加载情况。\n- 检查 404 页面、Pjax 切换、图片灯箱和懒加载,确认页面交互符合预期。\n\n主题还提供自定义网站配色、复制保护、PWA、系列文章、Instantpage 和 Snackbar 等能力。实际使用时应依据站点目标选择功能,避免一次性启用所有扩展。

注意事项与常见问题

  • Git 安装提供 master 与 dev 两个分支:master 标注为稳定版本,dev 标注为开发版本,选择开发版意味着使用抢先体验的新功能。\n- NPM 安装方式存在版本限制,仅支持 Hexo 5.0.0 及以上版本。\n- 如果访问 GitHub 较慢,README 提供了 Gitee 镜像地址,可用于获取主题代码。\n- Pug 与 Stylus 是主题安装后的关键渲染依赖;未安装时,页面渲染可能无法按主题要求完成,因此应先执行依赖安装命令。\n- 评论、搜索、统计、客服和分析能力包含多个服务选项,README 将它们列为主题支持能力;实际接入时应按所选服务完成对应配置。\n- 项目采用 Apache 2.0 授权条款,主题基于 hexo-theme-melody 开发。

优缺点

  • ✓ 响应式设计适配多种屏幕
  • ✓ 集成搜索、评论与数据分析
  • ✕ NPM安装仅支持 Hexo 5.0.0及

出处

本方案挖掘自开源项目 jerryc127/hexo-theme-butterfly,方案内容与实施命令均来自其 README 原文。

方案出处
jerryc127/hexo-theme-butterfly: 🦋 A Hexo Theme: Butterfly
8359 star 🦋 A Hexo Theme: Butterfly

本方案由真实开源项目挖掘整理,实施命令均来自其 README 原文,安装使用请遵循项目开源协议。