📝 Docs: update REAMDE (#37)

This commit is contained in:
Cell
2022-01-20 16:09:13 +08:00
parent c28cbb4e86
commit d730e0671b
2 changed files with 27 additions and 23 deletions
+14 -12
View File
@@ -21,6 +21,20 @@ The FixIt theme inherits the excellent functions of these themes, and adds new f
<!-- TODO update url -->
Head to this [documentation page](https://hugofixit.pages.dev/theme-documentation-basics/) for a complete guidence to get started with the FixIt theme.
### [Demo Site](https://lruihao.cn)
<!-- TODO update url -->
To see this theme in action, here is a live [demo site](https://lruihao.cn) which is rendered with **FixIt** theme.
### [Documentation](https://hugofixit.pages.dev/categories/documentation/)
<!-- TODO update url -->
Build Documentation Locally:
```bash
hugo server --source=exampleSite
```
Of course, you can also watch the [FixIt wiki](https://github.com/Lruihao/FixIt/wiki) directly.
## Migrate from LoveIt
If you are currently using the LoveIt theme (or some other themes), it is very easy to migrate to FixIt.
@@ -52,10 +66,6 @@ Next, go to the `config.toml` and change the default theme to `FixIt`.
Now the migration is finished and everything is ready 🎉
## [Demo Site](https://lruihao.cn)
<!-- TODO update url -->
To see this theme in action, here is a live [demo site](https://lruihao.cn) which is rendered with **FixIt** theme.
## Why choose FixIt
* Custom **Header**
@@ -157,14 +167,6 @@ the FixIt theme may be more suitable for you.
* **Friends** page embedded template
* ...
## [Documentation](https://hugofixit.pages.dev/categories/documentation/)
<!-- TODO update url -->
Build Documentation Locally:
```bash
hugo server --source=exampleSite
```
## Multilingual and i18n
FixIt supports the following languages:
+13 -11
View File
@@ -21,6 +21,19 @@ FixIt 主题继承了这些主题的优秀功能,并在此基础上添加了
<!-- TODO update url -->
前往这篇 [文档](https://hugofixit.pages.dev/zh-cn/theme-documentation-basics/),阅读关于安装与使用的详细指南。
### 主题 [预览](https://hugofixit.pages.dev/zh-cn/)
<!-- TODO update url -->
为了直观地浏览主题特性,这里有一个基于 **FixIt** 主题渲染的 [预览网站](https://hugofixit.pages.dev/zh-cn/)。
### [文档](https://hugofixit.pages.dev/zh-cn/categories/documentation/)
<!-- TODO update url -->
在本地构建文档:
```bash
hugo server --source=exampleSite
```
当然,你也可以直接看 [FixIt 主题维基](https://github.com/Lruihao/FixIt/wiki)
## 从 LoveIt 迁移
如果你现在正在使用 LoveIt 主题(或者一些其他的主题),你可以很容易地迁移至 FixIt。
@@ -52,10 +65,6 @@ sh fixit_checker.sh
这样就完成了迁移工作,现在一切准备就绪 🎉
## 主题 [预览](https://hugofixit.pages.dev/zh-cn/)
<!-- TODO update url -->
为了直观地浏览主题特性,这里有一个基于 **FixIt** 主题渲染的 [预览网站](https://hugofixit.pages.dev/zh-cn/)。
## 为什么选择 FixIt
* 自定义**标题栏**
@@ -157,13 +166,6 @@ sh fixit_checker.sh
* 支持**友情链接**的页面模板
* ...
## [文档](https://hugofixit.pages.dev/zh-cn/categories/documentation/)
<!-- TODO update url -->
在本地构建文档:
```bash
hugo server --source=exampleSite
```
## 多语言和国际化
FixIt 支持下列语言: