aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README-zh.md17
-rw-r--r--README.md17
2 files changed, 26 insertions, 8 deletions
diff --git a/README-zh.md b/README-zh.md
index cb5c133..a98b090 100644
--- a/README-zh.md
+++ b/README-zh.md
@@ -1,5 +1,10 @@
# hugo-theme-even
+[![GitHub contributors](https://img.shields.io/github/contributors/olOwOlo/hugo-theme-even.svg?colorB=green)](https://github.com/olOwOlo/hugo-theme-even/contributors)
+[![GitHub release](https://img.shields.io/github/release/olOwOlo/hugo-theme-even.svg?colorB=green)](https://github.com/olOwOlo/hugo-theme-even/releases)
+[![GitHub commits (since latest release)](https://img.shields.io/github/commits-since/olOwOlo/hugo-theme-even/latest.svg?colorB=green)](https://github.com/olOwOlo/hugo-theme-even/compare)
+[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/olOwOlo/hugo-theme-even/blob/master/LICENSE.md)
+
A super concise theme for Hugo
> 该主题移植自 [hexo-theme-even](https://github.com/ahonn/hexo-theme-even)
@@ -57,7 +62,7 @@ defaultContentLanguage = "en" # en / zh-cn / other...
## Shortcodes
-主题提供了 `center`,` right`, `left`,` music` 四种 shortcodes,并支持为内置的 `figure` 设置 `center`,` right`, `left` 这三种 class 值。点击[这里](https://blog.olowolo.com/example-site/post/shortcodes/)查看详细内容。
+主题提供了 `center`,` right`, `left`,` music`, `admonition` 这些 shortcodes,并支持为内置的 `figure` 设置 `center`,` right`, `left` 这三种 class 值。点击[这里](https://blog.olowolo.com/example-site/post/shortcodes/)查看详细内容。
## Theme Color
@@ -67,11 +72,15 @@ defaultContentLanguage = "en" # en / zh-cn / other...
如果你更改了 `/src/` 目录下的任意文件,你需要重新编译它们。
```bash
-cd ./themes/even/src/
-npm install
-npm run build
+cd ./themes/even/
+# install dependencies
+yarn install
+# build
+yarn build
```
+_你需要先安装 **[Yarn](https://yarnpkg.com/)** 和 **[Node.js](https://nodejs.org/)**。_
+
## Update Theme
```bash
diff --git a/README.md b/README.md
index 45e43e1..ddc16d5 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,10 @@
# hugo-theme-even
+[![GitHub contributors](https://img.shields.io/github/contributors/olOwOlo/hugo-theme-even.svg?colorB=green)](https://github.com/olOwOlo/hugo-theme-even/contributors)
+[![GitHub release](https://img.shields.io/github/release/olOwOlo/hugo-theme-even.svg?colorB=green)](https://github.com/olOwOlo/hugo-theme-even/releases)
+[![GitHub commits (since latest release)](https://img.shields.io/github/commits-since/olOwOlo/hugo-theme-even/latest.svg?colorB=green)](https://github.com/olOwOlo/hugo-theme-even/compare)
+[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/olOwOlo/hugo-theme-even/blob/master/LICENSE.md)
+
A super concise theme for Hugo
> It's a port of the [hexo-theme-even](https://github.com/ahonn/hexo-theme-even)
@@ -57,7 +62,7 @@ You can customize something for a single content in the content's front-matter.
## Shortcodes
-This theme provides `center`,` right`, `left`,` music` four shortcodes, and support `center`,` right`, `left` class for the built-in `figure`. See more information from [there](https://blog.olowolo.com/example-site/post/shortcodes/).
+This theme provides `center`,` right`, `left`,` music`, `admonition` shortcodes, and support `center`,` right`, `left` class for the built-in `figure`. See more information from [there](https://blog.olowolo.com/example-site/post/shortcodes/).
## Theme Color
@@ -67,11 +72,15 @@ There are five built-in theme colors ( Default | Mint Green | Cobalt Blue | Hot
If you changed any file under `/src/`, you need to rebuild.
```bash
-cd ./themes/even/src/
-npm install
-npm run build
+cd ./themes/even/
+# install dependencies
+yarn install
+# build
+yarn build
```
+_You need to install **[Yarn](https://yarnpkg.com/)** and **[Node.js](https://nodejs.org/)** first._
+
## Update Theme
```bash