mirror of
https://github.com/hugo-fixit/FixIt.git
synced 2026-08-24 15:28:57 +00:00
Cell
2c0b48370b
* feat(gen-docs): add documentation generation package with SassDoc and TypeDoc support Add new `@hugo-fixit/gen-docs` package that parses Hugo config (hugo.toml) and generates documentation. Includes SassDoc annotations for SCSS variables and mixins, TypeDoc config for TypeScript source docs, and a `.sassdocrc` configuration file. * docs(readme): add browsers support section * feat(gen-docs): add Hugo partials docs generation and fix config empty sections - Add partial-parser.ts: parses Hugo partial comment blocks (@param/@return/@example) - Add partials.ts renderer: generates grouped Markdown with param tables - Add `partials` subcommand with -t/-o options for template injection - Fix config-parser: empty TOML sections (library.js/library.css) now retain descriptions - Fix config-parser: correctly distinguish section-level vs key-level comments - Update README with partials subcommand documentation
16 KiB
16 KiB
FixIt 是一个简洁、优雅且高效的 Hugo 博客主题。
如果你喜欢这个主题，别忘了留下一颗 ⭐️ 哦，谢谢！
FixIt
Warning
v0.x 版本仅接受 bug 修复，如需提交新功能，请基于 v1 分支开发。
1.0 版本计划在 2027 年上半年 发布，欢迎加入开发和讨论！详见 v1 里程碑。
即时预览
💟 Docs | ❇️ Test | 🚼 Demo | 🆕 Starter
更多 FixIt 的例子参见 这里。
使用指南
主题文档
前往 快速上手 页面，了解如何使用 FixIt 主题创建一个新网站的详细步骤。
快速开始
我们提供了一个 CLI 工具，可以通过一个命令来创建一个新的 FixIt 项目。
pnpx fixit-cli create my-blog
模板
点击以下链接使用模板生成一个新的仓库：
| 模板 | 仓库 | 生成链接 |
|---|---|---|
| 基于 Hugo Modules 的快速入门模板。 | hugo-fixit-starter | 点击生成 |
| 基于 Git submodule 的快速入门模板。 | hugo-fixit-starter1 | 点击生成 |
| 使用 Fixit 主题构建多语言网站。 | docs | 点击生成 |
| 基于 FixIt 主题进行自定义设置。 | Lruihao/hugo-blog | 点击生成 |
特色
点击展开
性能和 SEO
- 性能优化：在 Google PageSpeed Insights 中，99/100 的移动设备得分和 100/100 的桌面设备得分
- 使用基于 JSON-LD 格式的 SEO SCHEMA 文件进行 SEO 优化
- 支持 Google Analytics
- 支持 Fathom Analytics
- 支持 百度统计
- 支持 Umami Analytics
- 支持 Plausible Analytics
- 支持 Cloudflare Web Analytics
- 支持 Splitbee Analytics
- 支持搜索引擎的 网站验证 (Google, Bing, Yandex, Pinterest, Baidu, 360 and Sogou)
- 支持所有第三方库的 CDN
外观和布局
- 响应式 布局
- 浅色/深色 主题模式
- 全局一致的 设计语言
- 支持 分页
- 易用和自动展开的 文章目录
- 支持 多语言 和国际化
- 美观的 CSS 动画
社交和评论系统
- 支持 Gravatar 头像
- 支持本地 头像
- 支持多达 87 种社交链接
- 支持多达 28 种网站分享
- 支持 Disqus 评论系统
- 支持 Gitalk 评论系统
- 支持 Valine 评论系统
- 支持 Waline 评论系统
- 支持 Facebook 评论系统
- 支持 Telegram comments 评论系统
- 支持 Commento 评论系统
- 支持 Utterances 评论系统
- 支持 Artalk 评论系统
- 支持 Twikoo 评论系统
- 支持 giscus 评论系统
扩展功能
- 支持基于 PostChat 的 AI 摘要、AI 搜索 和 AI 智能客服
- 支持 渐进式网页应用
- 支持 二级菜单
- 支持 内容加密（页面、局部）
- 支持 友情链接 的页面模板
- 支持基于 algolia、Fuse.js、Pagefind、CSE 或 PostChat 的 搜索
- 支持基于 Google 的 自定义搜索引擎 (CSE)
- 支持 Twemoji
- 支持 代码高亮
- 一键 复制代码 到剪贴板
- 支持基于 lightgallery 的 图片画廊
- 支持 Font Awesome 图标 的 Markdown 扩展语法
- 支持 上标注释 的 Markdown 扩展语法
- 支持 分数 的 Markdown 扩展语法
- 支持多种 admonitions shortcode 或 alerts 的 Markdown 扩展语法
- 支持 标签页 的 shortcode，提供多种设计样式
- 支持基于 KaTeX 或 MathJax 的 数学公式
- 支持基于 mermaid 的 图表 代码块扩展语法和 shortcode
- 支持基于 ECharts 的 交互式数据可视化 代码块扩展语法和 shortcode
- 支持 Timeline 的代码块扩展语法和 shortcode
- 支持 文件树 的代码块扩展语法和 shortcode
- 支持基于 Mapbox GL JS 的 Mapbox shortcode
- 支持基于 APlayer 和 MetingJS 的 音乐播放器 shortcode
- 支持 Bilibili 视频 和 抖音视频 shortcode
- 支持 自定义样式 的 shortcode
- 支持 自定义脚本 的 shortcode
- 支持 自定义模板块
- 支持基于 TypeIt 的打字动画 shortcode
- 支持基于 cookieconsent 的 Cookie 许可横幅
- 支持基于 cell-watermark 的 网页水印
- 支持基于 pangu.js 的 中文排版
- 支持本地 缓存远程图床图片
- ……
多语言和国际化
FixIt 主题多语言基本配置及自动翻译等详见 内容管理 文档，欢迎 贡献一种新的语言。
FixIt 支持下列语言。
- 英语
- 简体中文
- 繁体中文
- 法语
- 波兰语
- 巴西葡萄牙语
- 意大利语
- 西班牙语
- 德语
- 塞尔维亚语
- 俄语
- 罗马尼亚语
- 越南语
- 印地语
- 日语
- 韩语
浏览器支持
FixIt 主题支持所有主流浏览器的最近两个版本。
主题组件
为了平衡 FixIt 主题的 简洁性 和 可扩展性，我们额外开发了一系列 Hugo 主题组件 供用户选择。
点击展开
- fixit-bundle
🌲 Bundles the FixIt core theme and all hugo-fixit components into a single component. - cmpt-flyfish
🐟 A canvas implemented animation effect of small fish swimming. - cmpt-mdevtools
Mobile devtools component powered by vConsole and eruda. - cmpt-santa-hat
A Christmas Easter Egg by JavaScript. - cmpt-translate
🌐 A component for site automatic translation. - component-projects
🐙 Display your GitHub projects in the FixIt theme and generate blog posts from readme. - hugo-atom-feed
Hugo theme component for ATOM feed custom Output Format. - hugo-json-feed
Hugo theme component for JSON feed custom Output Format. - shortcode-asciinema
A Hugo theme component with asciinema-embed shortcode. - shortcode-caniuse
A Hugo theme component with caniuse shortcode. - shortcode-docs-bookmark
🔖 Embed bookmark of FixIt Docs. - shortcode-missing-translation
A Hugo theme component with missing-translation shortcode. - shortcode-mmt-netease
🎶 A Hugo theme component with a NetEase Cloud random comment shortcode. - shortcode-rewards
A Hugo theme component with reward-log or sponsor-log shortcode.
社区支持
所有的反馈都是欢迎的！详见 Discussions、Pull requests 和 Issues。
| 官方社区 | 说明 |
|---|---|
| Discussions | GitHub 讨论区 |
| FixIt 主题交流群（微信） | 关注「菠菜眾長」回复“FixIt”获取 |
| FixIt 主题交流群（QQ） | QQ 群：814031017 |
| FixIt 开发交流群 | QQ 群：770835493 |
参与贡献
我们欢迎你加入 FixIt 的开发，贡献出你的一份力量。请看开源 贡献指南。 🤗
你也可以随时向我们的 官方插件 提交 Issue 或 Pull Request。
Note
在贡献时，请先通过此存储库上的讨论来讨论你希望进行的更改，然后再进行实际更改。
致谢
感谢 所有贡献者 的支持！
感谢 Hugo DoIt 主题和 Hexo NexT 主题给予的灵感和借鉴。
感谢 FixIt 主题中使用的所有开源项目。
- UnoCSS
- normalize.css
- Font Awesome
- Simple Icons
- Animate.css
- autocomplete
- algoliasearch
- Fuse.js
- object-fit-images
- Twemoji
- emoji-data
- lightgallery
- Sharer.js
- TypeIt
- KaTeX
- MathJax
- mermaid
- ECharts
- Mapbox GL JS
- APlayer
- MetingJS
- Gitalk
- Valine
- cookieconsent
- cell-watermark
- 不蒜子
- Vercount
- pangu.js
- Artalk
- Waline
- Twikoo
- github-corners
- giscus
- pace
<tab-container>element<json-viewer>element
许可协议
FixIt 根据 MIT 许可协议授权。更多信息请查看 LICENSE 文件。
赞助支持
如果你喜爱这个主题，请考虑给我买杯咖啡 ☕️，谢谢！
感谢以下赞助商提供大力支持：
- translate.js 赞助 企业级翻译通道。