diff options
| author | He Yeshuang <yeshuanghe@gmail.com> | 2020-05-17 11:56:58 +0300 |
|---|---|---|
| committer | He Yeshuang <yeshuanghe@gmail.com> | 2020-05-18 15:15:49 +0300 |
| commit | 9fc1ae18f8031128fe917d27ccb11f1eee773465 (patch) | |
| tree | b8186d3b83afbb8bd796eb9b912faab6b8208d5b /README.md | |
| parent | 1ce153b4097c9fcedef1758c74d16e2a06d8c9c2 (diff) | |
update readme and clean up
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 16 insertions, 6 deletions
@@ -1,13 +1,22 @@ -# Theme Tokiwa for [Hugo](http://gohugo.io/) +# Theme Tokiwa -Tokiwa-iro is the main color tone and the name of this theme. +Theme Tokiwa is a minimalistic blog theme. Tokiwa-iro is the main color tone and the name of this theme. -Built on the top of [Hugo Static Site Generator Blank Starter Theme](https://jimfrenette.com/2019/02/hugo-static-site-generator-blank-starter-theme/). +Built on the top of [Hugo Starter Theme](https://jimfrenette.com/2019/02/hugo-static-site-generator-blank-starter-theme/) and [Tailwind CSS](https://tailwindcss.com/). Inspired by [Tailwind Toolbox - Minimalist-Blog](https://github.com/tailwindtoolbox/Minimalist-Blog). + +This theme is especially optimized for Chinese characters, while works well with other languages. ## Screenshot - + + + +## Install +Inside the folder of your Hugo site run: +```bash +$ git submodule add https://github.com/heyeshuang/hugo-theme-tokiwa.git themes/tokiwa +``` ## available config params ```toml @@ -43,7 +52,7 @@ youtube="http://twitter.com/hh" github="http://github.com/hh" ``` -A complete `config.toml` is in the `exampleSite` folder. +A complete `config.toml` example is in the `exampleSite` folder. ## Dev this Templates @@ -76,7 +85,8 @@ npm run build * [hugoBasicExample](https://github.com/gohugoio/hugoBasicExample.git) is used to mock data. * [Hugo Static Site Generator Blank Starter Theme](https://jimfrenette.com/2019/02/hugo-static-site-generator-blank-starter-theme/) -* Font `杨任东竹石体` is used for the banner. Non-Chinese user may want to delete `/static/fonts` to reduce the size. +* [Tailwind Toolbox - Minimalist-Blog](https://github.com/tailwindtoolbox/Minimalist-Blog) +* Font `杨任东竹石体` is used for the banner. * Beautiful icons made by [Remix-Design](https://github.com/Remix-Design/remixicon). Thanks.
\ No newline at end of file |