11 KiB
FixIt 主题 | Hugo
English README | 简体中文说明
它的原型基于 LoveIt 主题, LeaveIt 主题 和 KeepIt 主题。
LoveIt 主题 对我们来说是一个很棒的 Hugo 主题,很抱歉的是它的存储库已经停止维护很长一段时间了,所以我重建了一个名为 FixIt 的新主题,这样我可以更好地 Fix It 并使它用户体验更好。
FixIt 主题继承了这些主题的优秀功能,并在此基础上添加了新的功能与优化,请阅读 为什么选择 FixIt 来了解更多。
立即开始
前往这篇 文档,阅读关于安装与使用的详细指南。
或者,在本地构建 文档:
hugo server --source=exampleSite
当然,你也可以直接阅读 FixIt 主题维基
迁移和升级
如果你现在正在使用 LoveIt 主题(或者一些其他的主题),你可以很容易地迁移至 FixIt。
你可以将这个主题仓库添加为你的网站目录的子模块。
git submodule add https://github.com/Lruihao/FixIt.git themes/FixIt
之后,你可以在站点目录通过这条命令来将主题更新至最新版本:
git submodule update --remote --merge
或者在主题目录中使用 shell 命令 fixit_checker.sh 将主题更新至最新版本:
sh fixit_checker.sh
接着,前往 config.toml 并将默认主题更改为 FixIt。
- theme = "LoveIt"
+ theme = "FixIt"
这样就完成了迁移工作,现在一切准备就绪 🎉
为什么选择 FixIt
- 自定义标题栏(支持子菜单)
- 自定义 CSS 样式
- 焕然一新的主页,已经兼容最新版 Hugo
- 大量的样式细节调整,包括颜色、字体大小、边距、代码预览样式
- 可读性更强的深色模式
- 一些美观的 CSS 动画
- 易用和自动展开的文章目录
- 支持更多的社交链接、网站分享和评论系统
- 支持基于 Lunr.js 或 algolia 的搜索
- 一键复制代码到剪贴板
- 支持基于 Font Awesome 图标的扩展 Markdown 语法
- 支持上标注释的扩展 Markdown 语法
- 支持分数的扩展 Markdown 语法
- 支持基于 KaTeX 的数学公式
- 支持基于 mermaid 的图表生成功能
- 支持基于 ECharts 的交互式数据可视化生成功能
- 支持基于 Mapbox GL JS 的 Mapbox 地图显示功能
- 支持基于 APlayer 和 MetingJS 的内嵌音乐播放器
- 支持内嵌 Bilibili 视频
- 支持多种注释的 shortcode
- 支持自定义样式的 shortcode
- 支持所有第三方库的 CDN
- 支持渐进式网页应用
- 支持基于 cell-watermark 的网页水印
- 支持基于 pangu.js 的中文排版
- 支持卡片式链接的 shortcode
- 支持友情链接的页面模板
- ...
所以,
如果你更偏好 FixIt 主题的设计语言和自由度,
如果你想便捷地使用扩展的 Font Awesome 图标,
如果你想在文章内嵌数学公式、流程图、音乐或是 Bilibili 视频,
那么,FixIt 主题可能是更适合你。
谁在用 FixIt
为了直观地浏览主题特性,这里有一些基于 FixIt 主题渲染的预览网站。
- FixIt 主题官网
- FixIt 主题官网 - 预览
- 李瑞豪的博客
- hiifong的博客
- 你可以通过 提交 PR 添加你的网站(例如:#111)
特性
性能和 SEO
- 性能优化:在 Google PageSpeed Insights 中, 99/100 的移动设备得分和 100/100 的桌面设备得分
- 使用基于 JSON-LD 格式 的 SEO SCHEMA 文件进行 SEO 优化
- 支持 Google Analytics
- 支持 Fathom Analytics
- 支持搜索引擎的网站验证 (Google, Bind, Yandex and Baidu)
- 支持所有第三方库的 CDN
- 基于 lazysizes 自动转换图片为懒加载
外观和布局
- 响应式布局
- 浅色/深色 主题模式
- 全局一致的设计语言
- 支持分页
- 易用和自动展开的文章目录
- 支持多语言和国际化
- 美观的 CSS 动画
社交和评论系统
- 支持 Gravatar 头像
- 支持本地头像
- 支持多达 73 种社交链接
- 支持多达 28 种网站分享
- 支持 Disqus 评论系统
- 支持 Gitalk 评论系统
- 支持 Valine 评论系统
- 支持 Waline 评论系统
- 支持 Facebook 评论系统
- 支持 Telegram comments 评论系统
- 支持 Commento 评论系统
- 支持 Utterances 评论系统
- 支持 Artalk 评论系统
- 支持 Twikoo 评论系统
扩展功能
- 支持基于 Lunr.js 或 algolia 的搜索
- 支持 Twemoji
- 支持代码高亮
- 一键复制代码到剪贴板
- 支持基于 lightgallery.js 的图片画廊
- 支持 Font Awesome 图标的扩展 Markdown 语法
- 支持上标注释的扩展 Markdown 语法
- 支持分数的扩展 Markdown 语法
- 支持基于 KaTeX 的数学公式
- 支持基于 mermaid 的图表 shortcode
- 支持基于 ECharts 的交互式数据可视化 shortcode
- 支持基于 Mapbox GL JS 的 Mapbox shortcode
- 支持基于 APlayer 和 MetingJS 的音乐播放器 shortcode
- 支持 Bilibili 视频 shortcode
- 支持多种注释的 shortcode
- 支持自定义样式的 shortcode
- 支持自定义脚本的 shortcode
- 支持基于 TypeIt 的打字动画 shortcode
- 支持基于 cookieconsent 的 Cookie 许可横幅
- 支持渐进式网页应用
- 支持基于 cell-watermark 的网页水印
- 支持基于 pangu.js 的中文排版
- 支持卡片式链接的 shortcode
- 支持友情链接的页面模板
- ...
多语言和国际化
FixIt 支持下列语言:
路线图
更新日志
问题、想法、bugs 和 PRs
参与贡献
请参阅 CONTRIBUTING.md 以了解贡献该项目的基本信息。
确保在贡献和参与讨论时遵守 CODE_OF_CONDUCT.md。
贡献时,请先通过此存储库上的问题讨论您希望进行的更改,然后再进行实际更改。
所有贡献者
许可协议
FixIt 根据 MIT 许可协议授权。 更多信息请查看 LICENSE 文件。
FixIt 主题中用到了以下项目,感谢它们的作者:
- normalize.css
- Font Awesome
- Simple Icons
- Animate.css
- autocomplete.js
- Lunr.js
- algoliasearch
- lazysizes
- object-fit-images
- Twemoji
- lightgallery.js
- Sharer.js
- TypeIt
- KaTeX
- mermaid
- ECharts
- Mapbox GL JS
- APlayer
- MetingJS
- Gitalk
- Valine
- cookieconsent
- cell-watermark
- pangu.js
- Artalk
- Waline
- Twikoo
- github-corners
