From 13102bf12f21649663871265acffbe6107edc6db Mon Sep 17 00:00:00 2001 From: amazingrise <8315221+AmazingRise@users.noreply.github.com> Date: Fri, 14 May 2021 19:58:22 +0800 Subject: Update README. --- README.md | 74 +++++++++++++++++++++++++++++++++++--------------- images/dark.png | Bin 0 -> 181808 bytes images/essay.png | Bin 400640 -> 546977 bytes images/essay2.png | Bin 169349 -> 211555 bytes images/m_drawer.png | Bin 48124 -> 279745 bytes images/m_main.png | Bin 123584 -> 236439 bytes images/main.png | Bin 0 -> 387349 bytes images/screenshot.png | Bin 292101 -> 386455 bytes 8 files changed, 52 insertions(+), 22 deletions(-) create mode 100644 images/dark.png create mode 100644 images/main.png diff --git a/README.md b/README.md index 01094cc..e8ec254 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@
![](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 + +
+CHANGELOG + +1.3.0: + +- Removed jQuery and other redundant scripts. +- Some improvements on performance. + +
+ ## Quick Start +
+Click to expand + 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 ../.. ``` + +
+ ## 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 +
+Index Page -![](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. +
-![](https://raw.githubusercontent.com/AmazingRise/hugo-theme-diary/master/images/essay.png) +
+Post -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 +
+ +
+Dark Mode + +![](https://raw.githubusercontent.com/AmazingRise/hugo-theme-diary/master/images/dark.png) + +
+ +
+Mobile View ![](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) + +
+ + -![](https://raw.githubusercontent.com/AmazingRise/hugo-theme-diary/master/images/m_drawer.png) \ No newline at end of file + diff --git a/images/dark.png b/images/dark.png new file mode 100644 index 0000000..f90d330 Binary files /dev/null and b/images/dark.png differ diff --git a/images/essay.png b/images/essay.png index 37bf8fe..6efb5bc 100644 Binary files a/images/essay.png and b/images/essay.png differ diff --git a/images/essay2.png b/images/essay2.png index ca3acae..f321d19 100644 Binary files a/images/essay2.png and b/images/essay2.png differ diff --git a/images/m_drawer.png b/images/m_drawer.png index 86f590a..073544d 100644 Binary files a/images/m_drawer.png and b/images/m_drawer.png differ diff --git a/images/m_main.png b/images/m_main.png index 5f99924..66a6174 100644 Binary files a/images/m_main.png and b/images/m_main.png differ diff --git a/images/main.png b/images/main.png new file mode 100644 index 0000000..49ca897 Binary files /dev/null and b/images/main.png differ diff --git a/images/screenshot.png b/images/screenshot.png index 5fdb015..c513150 100644 Binary files a/images/screenshot.png and b/images/screenshot.png differ -- cgit v1.2.3