📝 Update the README content.

2022-10-02 11:11:37 +08:00
parent 3f8ab12e47
commit 4381eee782
3 changed files with 140 additions and 38 deletions
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-[中文](README.zh.md) | [English](#)
+[中文](https://github.com/hugo-next/hugo-theme-next/blob/main/README.zh.md) | [English](#)

 <a title="Hugo NexT Website" href="https://preview.hugo-next.eu.org">
  <img align="right" alt="NexT logo" width="266" src="https://lisenhui.gitee.io/imgs/hugo-next/logo/hugo-next-primary.png">
@@ -12,14 +12,14 @@

 [![Gitter](https://img.shields.io/gitter/room/hugo-next/hugo-them-next?logo=gitter&style=flat-square)](https://gitter.im/hugo-next/community) [![Build Hugo Version](https://img.shields.io/badge/Hugo-%3E=0.89.0-red?style=flat-square&logo=hugo&color=%23FF4088&&label=Hugo%20Extended)](https://github.com/gohugoio/hugo/releases/latest) [![GitHub deployments](https://img.shields.io/github/deployments/hugo-next/hugo-next.github.io/github-pages?style=flat-square&label=gh-pg&logo=GitHub)](https://github.com/hugo-next/hugo-theme-next) [![Repos Size](https://img.shields.io/github/repo-size/hugo-next/hugo-theme-next?style=flat-square&color=%23FFBF3B&logo=Files)](https://github.com/hugo-next/hugo-theme-next/find/main) [![GitHub](https://img.shields.io/github/license/hugo-next/hugo-theme-next?logo=webauthn&style=flat-square)](https://github.com/hugo-next/hugo-theme-next/blob/main/LICENSE)

-## 4 Scheme
+## 🎨 4 Scheme

 * :heart_decoration: Muse
 * :six_pointed_star: Mist
 * :pisces: Pisces
 * :gemini: Gemini (**default**)

-## Live Preview
+## 👀 Live Preview

 | Environment | :gemini: (**Default**) | :heart_decoration: | :six_pointed_star: | :pisces: | Status |
 | :---: | :---: | :---: | :---: | :---: | :---: |
@@ -29,22 +29,44 @@
 > - Preliminary: all new feature developments will be previewed as soon as possible.
 > - Production: Only the features that are tested stably and meet the requirements will be officially released.

-## Quick Start
+## 👣 Quick Start

-Before use `Hugo NexT` theme, please make sure installed `Git` & `Hugo Extened` software in your PC, then use `submodule` to lead into the theme, see below commands:
+Before use `Hugo NexT` theme, please make sure installed `Git` & `Hugo Extened` software in your PC.
+
+
+###  📰 Use Template
+
+If there your first time build blog site, Recommended use template of `Github` which can easily create your site code. Click & visit this repository: [hugo-theme-next-starter](https://github.com/hugo-next/hugo-theme-next-starter), then click the green button which name call `Use this template` upper right corner on the page. Just like below image:
+
+![Use Template](https://imgs.lisenhui.cn/hugo-next/use-hugo-next-starter.png)
+
+After do that click the green button which name call `Create repository from template`, then will create your site code automatic, and clone it on your PC environment.
+
+### 📐 Direct Reference
+
+If you had a blog site, then use `submodule` to lead into the theme, see below commands:

 ```shell
-$ hugo new site hugo-next-exmaple
 $ cd hugo-next-exmaple
-$ git init
 $ git submodule add https://github.com/hugo-next/hugo-theme-next.git themes/hugo-theme-next
-$ cp -r themes/hugo-theme-next/exampleSite/* .
-$ rm -rf config.toml
+$ cp themes/hugo-theme-next/exampleSite/config.yaml .
+$ mv config.toml config.toml.backup
+```
+
+### 💻 Preview on Local
+
+```shell
+$ cd hugo-next-exmaple
 $ hugo server
 ```

 Done that input adrress http://127.0.0.1:1313/ on browser will see the effect & good luck for you! :tada::tada::tada:

+> **Note**
+> Don't use `hugo server` command deploy your site and enable internet visit, it just used to preview when you develop on local environment. Recommended use `hugo` command build static files all site, then deploy them into Web server such as `Nginx`.
+
+### 🔄 Upgrade Theme
+
 Execute command as below in your site directory when the theme upgrade.

 ```shell
@@ -52,13 +74,15 @@ $ cd hugo-next-exmaple
 $ git submodule update --remote
 ```

-## New Post
+## 📝 New Post

 There had ready a new post template for you,  It is recommended to use the following Hugo command to quickly create a new post:

 ```sh
 $ hugo new posts/hello-world.md
 ```
+> **Note**
+> By defalut `hugo new` command will create new post under `content` root directory, so in here `posts` were you custom subfolder in `content` directory.

 All front matter parameters's description in post as below:

@@ -97,32 +121,58 @@ tags:
 #url: "{{ lower .Name }}.html"
 # Sticky post set-top in home page and the smaller nubmer will more forward.
 #weight: 1
+# Support Math Formulas render, options: mathjax, katex
+#math: mathjax
+# Enable chart render, such as: flow, sequence, classes etc
+#mermaid: true
 ---
 ```

-## Feedback
+## 🎉 User's Cases
+
+- [Hugo Docs & Demo](https://hugo-next.eu.org/)
+- [凡梦星尘空间站](https://lisenhui.cn/)
+- [阿哈吉](https://a.happy2008.top/)
+- [研究僧](https://yuanlucas.com/)
+- [Zero's Record](https://izeroo.cn/)
+- [More Cases](https://hugo-next.eu.org/flinks.html)
+
+Hope could submmit your site information in this file [flinks.yaml](https://github.com/hugo-next/hugo-next-docs/blob/develop/data/flinks.yaml) end line such as below code sytle when you use `Hugo NexT` theme, thanks.
+
+```yaml
+- name: NexT 主题
+  desc: 保持简单的易用性和强大的功能
+  avatar: https://hugo-next.eu.org/imgs/hugo_next_avatar.png
+  link: https://hugo-next.eu.org
+```
+
+## 🙋 Feedback

 - Join us [GitHub Discussions](https://github.com/hugo-next/hugo-theme-next/discussions) or [Gitter](https://gitter.im/hugo-next/community) to chat :beers:
 - [GitHub Issues](https://github.com/hugo-next/hugo-theme-next/issues/new?labels=Bug&template=bug-report.md) submit a new bug :bug:
 - [GitHub Feature](https://github.com/hugo-next/hugo-theme-next/issues/new?labels=Feature+Request&template=feature-request.md) tell me your ideas :sparkles:

-## Join us
+## 👨‍👩‍👧‍👦 Join us

 All features development progress and new request in [Hugo NexT V4 Roadmap](https://github.com/hugo-next/hugo-theme-next/issues/9), welcome to join us and compelete it together.

-## License
+## 📜 License

 [MIT License](LICENSE)

 Copyright (c) 2022, hugo-next teams.

-## Thanks
+## 💖 Thanks

 That's my hobby to develop `Hugo NexT` theme, thanks all people who gived the donate, and let we follow it growth up.

-List of Donors(Order by Date):
+List of Donors(Order desc by Date):

 | Donation time | Donors | Donation mode | Donation content | Message |
-| ------- | ------ | ------ | ---- | ---- |
-| 2021.12.21 | z*y | wechat pay | RMB 18.88 |  / |
-| 2022.05.08 | *泉 | wechat pay | RMB 6.60 | Good luck with next develop. |
+| :-------: | ------ | ------ | ---- | ---- |
+| 2022.09.30 | *軒 | wechat pay | ¥66.66 | Hope it could help more people. |
+| 2022.09.30 | N*l | wechat pay | ¥20.00 | / |
+| 2022.07.09 | *风 | wechat pay | ¥10.00 | / |
+| 2022.05.08 | *泉 | wechat pay | ¥6.60 | Good luck with next develop. |
+| 2022.02.28 | *娇 | wechat pay | ¥5.00 | / |
+| 2021.12.21 | z*y | wechat pay | ¥18.88 | / |