blogs/FixIt
1
0
Fork 0
mirror of https://github.com/hugo-fixit/FixIt.git synced 2026-08-24 15:28:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

📝 Docs: update README

Browse Source
This commit is contained in:
Cell
2024-04-04 01:47:12 +08:00
parent 4dc8d0f7d7
commit dc0b96210a
5 changed files with 49 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+22 -57
View File
@@ -6,65 +6,27 @@
👉 English README | [简体中文说明](README.zh-cn.md) 👉 English README | [简体中文说明](README.zh-cn.md)
> [FixIt](https://github.com/hugo-fixit/FixIt) is a **clean**, **elegant** but **advanced** blog theme for [Hugo](https://gohugo.io/). [FixIt](https://github.com/hugo-fixit/FixIt) is a **clean**, **elegant** but **advanced** blog theme for [Hugo](https://gohugo.io/).
It is based on the original [LoveIt Theme](https://github.com/dillonzq/LoveIt), [KeepIt Theme](https://github.com/Fastbyte01/KeepIt) and [LeaveIt Theme](https://github.com/liuzc/LeaveIt). It is based on the original [LoveIt Theme](https://github.com/dillonzq/LoveIt), [KeepIt Theme](https://github.com/Fastbyte01/KeepIt) and [LeaveIt Theme](https://github.com/liuzc/LeaveIt).[^1]
The FixIt theme inherits the excellent features of these themes, and adds new features and optimizations on those basis. Please read [Why Choose FixIt](#why-choose-fixit) to learn more. ![Hugo Theme FixIt](https://fixit.lruihao.cn/images/apple-devices-preview.webp)
![Hugo Theme FixIt](https://fixit.lruihao.cn/images/Apple-Devices-Preview.jpg)
## Getting started ## Getting started
Head to the [getting started page](http://fixit.lruihao.cn/documentation/getting-started/) or start with a template: - [Installation](https://fixit.lruihao.cn/documentation/installation/)
- [Getting Started](https://fixit.lruihao.cn/documentation/getting-started/)
- [Content Management](https://fixit.lruihao.cn/documentation/content-management/)
- [Advanced Usage](https://fixit.lruihao.cn/documentation/advanced/)
- [hugo-fixit/hugo-fixit-blog-git](https://github.com/hugo-fixit/hugo-fixit-blog-git) Alternatively, you can run the [documentation site](https://fixit.lruihao.cn/) locally. For more details, see [hugo-fixit/docs](https://github.com/hugo-fixit/docs).
- [hugo-fixit/hugo-fixit-blog-go](https://github.com/hugo-fixit/hugo-fixit-blog-go)
## [Documentation](https://fixit.lruihao.cn/categories/documentation/) ## Template repository
Head to this [documentation page](https://fixit.lruihao.cn/documentation/basics/) for a complete guidence to get started with the FixIt theme. - [hugo-fixit/hugo-fixit-start](https://github.com/hugo-fixit/hugo-fixit-start)
- [hugo-fixit/hugo-fixit-start1](https://github.com/hugo-fixit/hugo-fixit-start1)
Or run [Documentation Site](https://fixit.lruihao.cn) locally, see more details from [Contributing](#contributing). - [hugo-fixit/docs](https://github.com/hugo-fixit/docs)
- [Lruihao/hugo-blog](https://github.com/Lruihao/hugo-blog)
In addition, there is the [FixIt wiki](https://github.com/hugo-fixit/FixIt/wiki).
## Migrate from LoveIt
If you are currently using the LoveIt theme (or some other themes), it is very easy to migrate to FixIt.
You can add this repo as a submodule of your site directory. Alternatively, you can install the theme in [other ways](https://fixit.lruihao.cn/documentation/basics/#install-theme).
```bash
git submodule add https://github.com/hugo-fixit/FixIt.git themes/FixIt
```
And later you can update the submodule in your site directory to the latest commit using this command:
```bash
git submodule update --remote --merge
```
Next, go to the `hugo.toml` and change the default theme to `FixIt`.
```diff
- theme = "LoveIt"
+ theme = "FixIt"
```
Now the migration is finished and everything is ready 🎉
## Why choose FixIt
The FixIt theme inherits the excellent features of themes such as LoveIt, and adds new features and optimizations on those basis, as detailed in [Features](#features). In addition, the FixIt theme has the following advantages:
- Complete Chinese and English official documentations
- Community support: Theme official website, Discussions and official QQ group
- Continuously and actively update
- Constantly incorporate suggestions and ideas from all sides
- Highly open theme customizable section
In short, if you prefer the design language and freedom of the FixIt theme, and if you like to personalize your own themes as I do, the FixIt theme may be more suitable for you.
## Who used FixIt ## Who used FixIt
@@ -180,7 +142,7 @@ Make sure that you follow [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) while contrib
## Acknowledgements ## Acknowledgements
<details open> <details>
<summary>Thanks to the authors of following resources included in the theme:</summary> <summary>Thanks to the authors of following resources included in the theme:</summary>
- [normalize.css](https://github.com/necolas/normalize.css) - [normalize.css](https://github.com/necolas/normalize.css)
@@ -220,7 +182,7 @@ Make sure that you follow [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) while contrib
</details> </details>
<details open> <details>
<summary>The FixIt also draws on some features of the following projects, and thanks to their authors as well:</summary> <summary>The FixIt also draws on some features of the following projects, and thanks to their authors as well:</summary>
- [DoIt](https://github.com/HEIGE-PCloud/DoIt) - [DoIt](https://github.com/HEIGE-PCloud/DoIt)
@@ -234,15 +196,18 @@ FixIt is licensed under the **MIT** license. Check the [LICENSE file](LICENSE) f
## Author ## Author
[Lruihao](https://github.com/Lruihao "Follow me on GitHub") Follow [Lruihao](https://github.com/Lruihao "Follow me on GitHub")
## Sponsor ## Sponsor
Giving me a Star 🌟 is already the greatest encouragement and support for me.\ [![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/hugo-fixit/FixIt)
If you enjoy the theme, please consider buying me a coffee ☕️.
If you enjoy the theme, please consider buying me a coffee ☕️. Thanks!
- [PayPal](https://paypal.me/Lruihao) - [PayPal](https://paypal.me/Lruihao)
- [Alipay](images/alipay.jpg) - [Alipay](images/alipay.jpg)
- [Wechat](images/wechatpay.jpg) - [Wechat](images/wechatpay.jpg)
Thanks! ❤️ Don't forget to leave a ⭐️ if you like this theme, thanks!
[^1]: The theme name is interesting: "leave it, keep it, love it, fix it". Appears and leaves, loves but cannot keep. Doesn't it look like that damn love and BUG? 🤣
README.zh-cn.md
+25 -60
View File
@@ -6,65 +6,27 @@
👉 [English README](README.md) | 简体中文说明 👉 [English README](README.md) | 简体中文说明
> [FixIt](https://github.com/hugo-fixit/FixIt) 是一个**简洁**、**优雅**且**高效**的 [Hugo](https://gohugo.io/) 博客主题。 [FixIt](https://github.com/hugo-fixit/FixIt) 是一个**简洁**、**优雅**且**高效**的 [Hugo](https://gohugo.io/) 博客主题。[]
它的原型基于 [LoveIt 主题](https://github.com/dillonzq/LoveIt)，[KeepIt 主题](https://github.com/Fastbyte01/KeepIt) 和 [LeaveIt 主题](https://github.com/liuzc/LeaveIt)。 它的原型基于 [LoveIt 主题](https://github.com/dillonzq/LoveIt)，[KeepIt 主题](https://github.com/Fastbyte01/KeepIt) 和 [LeaveIt 主题](https://github.com/liuzc/LeaveIt)。[^1]
FixIt 主题继承了这些主题的优秀功能，并在此基础上添加了新的功能与优化，请阅读 [为什么选择 FixIt](#为什么选择-FixIt) 来了解更多。 ![Hugo Theme FixIt](https://fixit.lruihao.cn/images/apple-devices-preview.webp)
![Hugo Theme FixIt](https://fixit.lruihao.cn/images/Apple-Devices-Preview.jpg) ## 主题文档
## 快速上手 - [安装篇](https://fixit.lruihao.cn/zh-cn/documentation/installation/)
- [入门篇](https://fixit.lruihao.cn/zh-cn/documentation/getting-started/)
- [内容管理](https://fixit.lruihao.cn/zh-cn/documentation/content-management/)
- [进阶篇](https://fixit.lruihao.cn/zh-cn/documentation/advanced/)
前往 [快速上手页面](https://fixit.lruihao.cn/zh-cn/documentation/getting-started/) 或从一个模板直接开始： 或者在本地运行 [文档站点](https://fixit.lruihao.cn/zh-cn/)，更多细节详见 [hugo-fixit/docs](https://github.com/hugo-fixit/docs)。
- [hugo-fixit/hugo-fixit-blog-git](https://github.com/hugo-fixit/hugo-fixit-blog-git) ## 模板仓库
- [hugo-fixit/hugo-fixit-blog-go](https://github.com/hugo-fixit/hugo-fixit-blog-go)
## [完整文档](https://fixit.lruihao.cn/zh-cn/categories/documentation/) - [hugo-fixit/hugo-fixit-start](https://github.com/hugo-fixit/hugo-fixit-start)
- [hugo-fixit/hugo-fixit-start1](https://github.com/hugo-fixit/hugo-fixit-start1)
前往这篇 [文档](https://fixit.lruihao.cn/zh-cn/documentation/basics/)，阅读关于安装与使用的详细指南。 - [hugo-fixit/docs](https://github.com/hugo-fixit/docs)
- [Lruihao/hugo-blog](https://github.com/Lruihao/hugo-blog)
或者在本地运行 [文档站点](https://fixit.lruihao.cn/zh-cn/)，更多细节详见 [参与贡献](#参与贡献)。
除此之外，还有 [FixIt 主题维基](https://github.com/hugo-fixit/FixIt/wiki)。
## 从 LoveIt 迁移
如果你现在正在使用 LoveIt 主题（或者一些其他的主题），你可以很容易地迁移至 FixIt。
你可以将这个主题仓库添加为你的网站目录的子模块。或者，你可以通过 [其他方式](https://fixit.lruihao.cn/zh-cn/documentation/basics/#install-theme) 安装主题。
```bash
git submodule add https://github.com/hugo-fixit/FixIt.git themes/FixIt
```
之后，你可以在站点目录通过这条命令来将主题更新至最新版本：
```bash
git submodule update --remote --merge
```
接着，前往 `hugo.toml` 并将默认主题更改为 `FixIt`。
```diff
- theme = "LoveIt"
+ theme = "FixIt"
```
这样就完成了迁移工作，现在一切准备就绪 🎉
## 为什么选择 FixIt
FixIt 主题继承了 LoveIt 等主题的优秀功能，并在它们的基础上添加了新的功能与优化，详见 [特性](#特性)。除此之外，FixIt 主题还有以下优点：
- 完善的中英文官方文档
- 社区支持：主题官网、Discussions 和官方 QQ 群
- 持续积极地更新
- 不断收纳各方的建议和想法
- 高度开放主题可自定义部分
总之，如果你更偏好 FixIt 主题的设计语言和自由度，如果你和我一样喜欢个性化自定义主题，那么，FixIt 主题可能是更适合你。
## 谁在用 FixIt ## 谁在用 FixIt
@@ -166,7 +128,7 @@ FixIt 支持下列语言：
## 问题、想法、bugs 和 PRs ## 问题、想法、bugs 和 PRs
所有的反馈都是欢迎的！详见 [议题](https://github.com/hugo-fixit/FixIt/issues) 或者 [讨论](https://github.com/hugo-fixit/FixIt/discussions)。 所有的反馈都是欢迎的！详见 [议题](https://github.com/hugo-fixit/FixIt/issues) 或者 [讨论](https://github.com/hugo-fixit/FixIt/discussions) 或者加入 QQ 群：`814031017`。
## 参与贡献 ## 参与贡献
@@ -184,7 +146,7 @@ FixIt 支持下列语言：
## 致谢 ## 致谢
<details open> <details>
<summary>FixIt 主题中用到了以下项目，感谢它们的作者：</summary> <summary>FixIt 主题中用到了以下项目，感谢它们的作者：</summary>
- [normalize.css](https://github.com/necolas/normalize.css) - [normalize.css](https://github.com/necolas/normalize.css)
@@ -224,7 +186,7 @@ FixIt 支持下列语言：
</details> </details>
<details open> <details>
<summary>FixIt 主题还借鉴了以下项目的部分功能，同样感谢它们的作者：</summary> <summary>FixIt 主题还借鉴了以下项目的部分功能，同样感谢它们的作者：</summary>
- [DoIt](https://github.com/HEIGE-PCloud/DoIt) - [DoIt](https://github.com/HEIGE-PCloud/DoIt)
@@ -234,19 +196,22 @@ FixIt 支持下列语言：
## 许可协议 ## 许可协议
FixIt 根据 **MIT** 许可协议授权。 更多信息请查看 [LICENSE 文件](LICENSE)。 FixIt 根据 **MIT** 许可协议授权。更多信息请查看 [LICENSE 文件](LICENSE)。
## 作者 ## 作者
[Lruihao](https://github.com/Lruihao "在 GitHub 上关注我") Follow [Lruihao](https://github.com/Lruihao "在 GitHub 上关注我")
## 赞助支持 ## 赞助支持
给我一个 Star 🌟 已经是对我最大的鼓励和支持了。\ [![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/hugo-fixit/FixIt)
如果你喜爱这个主题，请考虑给我买杯咖啡 ☕️。
如果你喜爱这个主题，请考虑给我买杯咖啡 ☕️，谢谢！
- [PayPal](https://paypal.me/Lruihao) - [PayPal](https://paypal.me/Lruihao)
- [支付宝](images/alipay.jpg) - [支付宝](images/alipay.jpg)
- [微信支付](images/wechatpay.jpg) - [微信支付](images/wechatpay.jpg)
谢谢！❤️ 如果你喜欢这个主题，别忘了留下一颗 ⭐️ 哦，谢谢！
[^1]: 主题名称趣谈：“leave it, keep it，love it，fix it”。出现又离开，爱而不得。这像不像那该死的爱情和 BUG 呢？🤣
hugo.toml
+2
View File
@@ -1,6 +1,8 @@
# ===================================================================================== # =====================================================================================
# It's recommended to use Alternate Theme Config to configure FixIt # It's recommended to use Alternate Theme Config to configure FixIt
# Modifying this file may result in merge conflict # Modifying this file may result in merge conflict
# There are currently some restrictions to what a theme component can configure:
# params, menu, outputformats and mediatypes
# ===================================================================================== # =====================================================================================
# ------------------------------------------------------------------------------------- # -------------------------------------------------------------------------------------
images/Apple-Devices-Preview.jpg
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 149 KiB

images/apple-devices-preview.webp
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 66 KiB