diff options
author | amazingrise <8315221+AmazingRise@users.noreply.github.com> | 2021-05-14 14:58:22 +0300 |
---|---|---|
committer | amazingrise <8315221+AmazingRise@users.noreply.github.com> | 2021-05-14 14:58:22 +0300 |
commit | 13102bf12f21649663871265acffbe6107edc6db (patch) | |
tree | 3c57a6257a1598c0c238bf69cb9487988673fbbc /README.md | |
parent | 1e48b1fc4057623b8675e4ab27c55d3961e5c0ba (diff) |
Update README.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 74 |
1 files changed, 52 insertions, 22 deletions
@@ -3,7 +3,7 @@ <div align="center"> ![](https://img.shields.io/badge/license-MIT-blue.svg) -![](https://img.shields.io/badge/version-1.2.1-brightgreen) +![](https://img.shields.io/badge/version-1.3.0-brightgreen) [✨Live Demo✨](https://amazingrise.net/) - [Intro Video](https://www.bilibili.com/video/av84273002) - @@ -20,26 +20,36 @@ A Hugo theme ported from [SumiMakito/hexo-theme-Journal](https://github.com/Sumi ## Features -Features in the ori.: +### Features of this theme -- Simple and easy to customize -- Concentrated on reading experience -- Mobile-friendly & widescreen-friendly -- Flexible commenting control - -Features in this ported version: - -- Dark mode. -- Abundant 3rd. service intergration. (Gitalk, LiveRe, Disqus, Waline, Twikoo, Google Search, Analytics... ) -- Table of Contents with scroll spy and auto collapse. -- LaTeX support (disabled by default). -- English, Chinese (CHS/CHT), French, German, Portuguese(Brazil) support. +- Customizable: Easy to customize with detailed project wiki. +- Adaptive: Mobile-friendly & widescreen-friendly. +- Abundant: 3rd. service intergration (Gitalk, LiveRe, Disqus, Waline, Twikoo, Google Search, Analytics... ). +- Convenient: Table of Contents with scroll spy. +- Professional: LaTeX support (disabled by default). +- Graceful: Dark mode (automatic or manual switch). +- International: English, Chinese (CHS/CHT), French, German, Portuguese(Brazil) support. - ... For details, please visit [project wiki](https://github.com/AmazingRise/hugo-theme-diary/wiki/). +### Features in new version + +<details> +<summary>CHANGELOG</summary> + +1.3.0: + +- Removed jQuery and other redundant scripts. +- Some improvements on performance. + +</details> + ## Quick Start +<details> +<summary>Click to expand</summary> + If your website is using Git as version control, please do as follows: 1. Fetch the theme dir. @@ -61,6 +71,9 @@ From the root of themes/diary/exampleSite: ```bash hugo server --themesDir ../.. ``` + +</details> + ## Personalization ### Example config @@ -94,24 +107,41 @@ See [/exampleSite/config.toml](https://github.com/AmazingRise/hugo-theme-diary/b * [Dark Mode](https://github.com/AmazingRise/hugo-theme-diary/wiki/Dark-Mode) - [Troubleshooting](https://github.com/AmazingRise/hugo-theme-diary/wiki/Troubleshooting) + ## Screenshots -Site Main Page +<details> +<summary>Index Page</summary> -![](https://raw.githubusercontent.com/AmazingRise/hugo-theme-diary/master/images/tn.png) +![](https://raw.githubusercontent.com/AmazingRise/hugo-theme-diary/master/images/main.png) -An essay with picture. +</details> -![](https://raw.githubusercontent.com/AmazingRise/hugo-theme-diary/master/images/essay.png) +<details> +<summary>Post</summary> -Table of Contents with scroll spy. +![](https://raw.githubusercontent.com/AmazingRise/hugo-theme-diary/master/images/essay.png) ![](https://raw.githubusercontent.com/AmazingRise/hugo-theme-diary/master/images/essay2.png) -Mobile View: Main Page +</details> + +<details> +<summary>Dark Mode</summary> + +![](https://raw.githubusercontent.com/AmazingRise/hugo-theme-diary/master/images/dark.png) + +</details> + +<details> +<summary>Mobile View</summary> ![](https://raw.githubusercontent.com/AmazingRise/hugo-theme-diary/master/images/m_main.png) -Mobile View: Drawer +![](https://raw.githubusercontent.com/AmazingRise/hugo-theme-diary/master/images/m_drawer.png) + +</details> + + -![](https://raw.githubusercontent.com/AmazingRise/hugo-theme-diary/master/images/m_drawer.png)
\ No newline at end of file +</details> |