From 9bfce6cbe6cf3651575be215d0ccd55c048931ce Mon Sep 17 00:00:00 2001 From: Cell <1024@lruihao.cn> Date: Sat, 21 Jan 2023 17:18:27 +0800 Subject: [PATCH] :pencil: Docs: update README and docs submodule Closes hugo-fixit/docs#4 --- README.md | 35 +++++++++++------------------------ README.zh-cn.md | 39 +++++++++++++-------------------------- docs | 2 +- 3 files changed, 25 insertions(+), 51 deletions(-) diff --git a/README.md b/README.md index 5cb25e7d..60de0ae1 100644 --- a/README.md +++ b/README.md @@ -28,18 +28,20 @@ hugo server --source=docs In addition, there is the [FixIt wiki](https://github.com/hugo-fixit/FixIt/wiki). -## Migrate and Update +## Install or Migrate 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. +You can add this repo as a submodule of your site directory. Alternatively, you can [install the theme](https://fixit.lruihao.cn/theme-documentation-basics/#install-theme) in other ways. ```bash -# Stable version git submodule add https://github.com/hugo-fixit/FixIt.git themes/FixIt +``` -# ⚠️ Dev version -git submodule add -b dev 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 `config.toml` and change the default theme to `FixIt`. @@ -51,14 +53,6 @@ Next, go to the `config.toml` and change the default theme to `FixIt`. Now the migration is finished and everything is ready 🎉 ---- - -And later you can update the submodule in your site directory to the latest commit using this command: - -```bash -git submodule update --remote --merge -``` - ## 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: @@ -71,24 +65,17 @@ The FixIt theme inherits the excellent features of themes such as LoveIt, and ad 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](https://fixit.lruihao.cn/friends/) +## Who used FixIt -| 📌 Site | Repo | +To see this theme in action, here are some [live demo sites](https://fixit.lruihao.cn/friends/) which are rendered with **FixIt** theme. + +| Site | Repo | | :----------------------------------------------------------- | :----------------------------------------------------------- | | [FixIt Theme Official Website](https://fixit.lruihao.cn), [FixIt Preview](https://pre.fixit.lruihao.cn) | [hugo-fixit/docs](https://github.com/hugo-fixit/docs) | | [FixIt Blog Template - Git](https://demo.fixit.lruihao.cn) | [hugo-fixit/hugo-fixit-blog-git](https://github.com/hugo-fixit/hugo-fixit-blog-git) | | [FixIt Blog Template - Go](https://demo.fixit.lruihao.cn) | [hugo-fixit/hugo-fixit-blog-go](https://github.com/hugo-fixit/hugo-fixit-blog-go) | | [Lruihao's note](https://lruihao.cn) | [Lruihao/hugo-blog](https://github.com/Lruihao/hugo-blog) | -To see this theme in action, here are some live demo sites which are rendered with **FixIt** theme. - -* [Ayang's blog](https://ayang.ink) -* [hiifong's blog](https://i.hiifong.cc) -* [Niku's blog](https://www.nikunokoya.com) -* [wlanxww's blog](https://wlanxww.com) - -You could add your FixIt site to the list in **nickname** lexicographical order via [making a PR](https://github.com/hugo-fixit/FixIt/pulls). (e.g. [#111](https://github.com/hugo-fixit/FixIt/pull/111)) - ## Features ### Performance and SEO diff --git a/README.zh-cn.md b/README.zh-cn.md index 09b3cf9e..16698c6b 100644 --- a/README.zh-cn.md +++ b/README.zh-cn.md @@ -28,20 +28,22 @@ git clone --recursive https://github.com/hugo-fixit/FixIt.git && cd FixIt hugo server --source=docs ``` -除此之外，还有[FixIt 主题维基](https://github.com/hugo-fixit/FixIt/wiki)。 +除此之外，还有 [FixIt 主题维基](https://github.com/hugo-fixit/FixIt/wiki)。 -## 迁移和升级 +## 安装或迁移 如果你现在正在使用 LoveIt 主题（或者一些其他的主题），你可以很容易地迁移至 FixIt。 -你可以将这个主题仓库添加为你的网站目录的子模块。 +你可以将这个主题仓库添加为你的网站目录的子模块。或者，您可以通过其他方式 [安装主题](https://fixit.lruihao.cn/zh-cn/theme-documentation-basics/#install-theme)。 ```bash -# 稳定版 git submodule add https://github.com/hugo-fixit/FixIt.git themes/FixIt +``` -# ⚠️ 开发版 -git submodule add -b dev https://github.com/hugo-fixit/FixIt.git themes/FixIt +之后，你可以在站点目录通过这条命令来将主题更新至最新版本： + +```bash +git submodule update --remote --merge ``` 接着，前往 `config.toml` 并将默认主题更改为 `FixIt`。 @@ -53,14 +55,6 @@ git submodule add -b dev https://github.com/hugo-fixit/FixIt.git themes/FixIt 这样就完成了迁移工作，现在一切准备就绪 🎉 ---- - -之后，你可以在站点目录通过这条命令来将主题更新至最新版本： - -```bash -git submodule update --remote --merge -``` - ## 为什么选择 FixIt FixIt 主题继承了 LoveIt 等主题的优秀功能，并在它们的基础上添加了新的功能与优化，详见 [特性](#特性)。除此之外，FixIt 主题还有以下优点： @@ -73,23 +67,16 @@ FixIt 主题继承了 LoveIt 等主题的优秀功能，并在它们的基础上 总之，如果你更偏好 FixIt 主题的设计语言和自由度，如果你和我一样喜欢个性化自定义主题，那么，FixIt 主题可能是更适合你。 -## [谁在用 FixIt](https://fixit.lruihao.cn/zh-cn/friends/) +## 谁在用 FixIt -| 📌 站点 | 仓库 | +为了直观地浏览主题特性，这里有一些基于 **FixIt** 主题渲染的 [预览网站](https://fixit.lruihao.cn/zh-cn/friends/)。 + +| 站点 | 仓库 | | :----------------------------------------------------------- | :---------------------------------------------------------- | | [FixIt 主题官网](https://fixit.lruihao.cn), [FixIt 预览版](https://pre.fixit.lruihao.cn) | [hugo-fixit/docs](https://github.com/hugo-fixit/docs) | | [FixIt 博客模板 - Git](https://demo.fixit.lruihao.cn) | [hugo-fixit/hugo-fixit-blog-git](https://github.com/hugo-fixit/hugo-fixit-blog-git) | | [FixIt 博客模板 - Go](https://demo.fixit.lruihao.cn) | [hugo-fixit/hugo-fixit-blog-go](https://github.com/hugo-fixit/hugo-fixit-blog-go) | -| [李瑞豪的博客](https://lruihao.cn) | [Lruihao/hugo-blog](https://github.com/Lruihao/hugo-blog) | - -为了直观地浏览主题特性，这里有一些基于 **FixIt** 主题渲染的预览网站。 - -* [Ayang 的博客](https://ayang.ink) -* [hiifong 的博客](https://i.hiifong.cc) -* [Niku 的博客](https://www.nikunokoya.com) -* [wlanxww 的博客](https://wlanxww.com) - -你可以 [提交 PR](https://github.com/hugo-fixit/FixIt/pulls) 按 **nickname** 以字典顺序将您的 FixIt 网站添加到列表中。（例如：[#111](https://github.com/hugo-fixit/FixIt/pull/111)） +| [李瑞豪的博客](https://lruihao.cn) | [Lruihao/hugo-blog](https://github.com/Lruihao/hugo-blog) | ## 特性 diff --git a/docs b/docs index a950fcf8..738995d2 160000 --- a/docs +++ b/docs @@ -1 +1 @@ -Subproject commit a950fcf8aa094242c3f1ff9809876a9a49d86583 +Subproject commit 738995d24106747a0f37c4c7e4c91a3384c550d0