Welcome to mirror list, hosted at ThFree Co, Russian Federation.

README.md - github.com/AmazingRise/hugo-theme-diary.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 01094ccf817d2b6f5d1e20148fe6073ea6cca3cd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# <div align="center">Hugo Theme Diary</div>

<div align="center">

![](https://img.shields.io/badge/license-MIT-blue.svg)
![](https://img.shields.io/badge/version-1.2.1-brightgreen)

[✨Live Demo✨](https://amazingrise.net/) -
[Intro Video](https://www.bilibili.com/video/av84273002) -
[Progress](https://github.com/AmazingRise/hugo-theme-diary/projects/) -
[Wiki](https://github.com/amazingrise/hugo-theme-diary/wiki)

隻言片語・於此匯聚

Moments piled up.

</div>

A Hugo theme ported from [SumiMakito/hexo-theme-Journal](https://github.com/SumiMakito/hexo-theme-Journal/).

## Features

Features in the ori.:

- 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.
- ...

For details, please visit [project wiki](https://github.com/AmazingRise/hugo-theme-diary/wiki/).

## Quick Start

If your website is using Git as version control, please do as follows:

1. Fetch the theme dir.

From the root of your Hugo site, open the terminal and execute:
```bash
git submodule add https://github.com/AmazingRise/hugo-theme-diary.git themes/diary
```
2. Update git repository.

Then update the git repository from the root of your site:
```bash
git submodule update --remote --merge
```

3. Run example site.

From the root of themes/diary/exampleSite:
```bash
hugo server --themesDir ../..
```
## Personalization

### Example config

See [/exampleSite/config.toml](https://github.com/AmazingRise/hugo-theme-diary/blob/master/exampleSite/config.toml)

### Customization

- [Wiki Home](https://github.com/AmazingRise/hugo-theme-diary/wiki)
- Configurations
  * [Internationalization(i18n)](https://github.com/AmazingRise/hugo-theme-diary/wiki/Internationalization)
  * [Sidebar](https://github.com/AmazingRise/hugo-theme-diary/wiki/Customization#customize-sidebar)
  * [Favicon](https://github.com/AmazingRise/hugo-theme-diary/wiki/Customization#add-favicon)
  * [Table Of Contents](https://github.com/AmazingRise/hugo-theme-diary/wiki/Table-Of-Contents)
  * [Enable/Disable Comment](https://github.com/AmazingRise/hugo-theme-diary/wiki/Comment-Area)
- 3rd. party services
  * [Comment Services](https://github.com/AmazingRise/hugo-theme-diary/wiki/Comment-Area)
  * [Google Analytics](https://github.com/AmazingRise/hugo-theme-diary/wiki/Customization#add-google-analytics)
  * [Google Site Verification](https://github.com/AmazingRise/hugo-theme-diary/wiki/Customization#add-google-site-verification)
  * [Google Search Intergration](https://github.com/AmazingRise/hugo-theme-diary/wiki/Customization#add-google-search-box-on-your-site)
- Writing
  * [Meta Data](https://github.com/AmazingRise/hugo-theme-diary/wiki/Post's-meta-data)
  * [LaTeX Support](https://github.com/AmazingRise/hugo-theme-diary/wiki/MathJax)
  * [RSS Feed](https://github.com/AmazingRise/hugo-theme-diary/wiki/RSS-Feed)
  * [Inserting Figures](https://github.com/AmazingRise/hugo-theme-diary/wiki/Inserting-Figures)
- Styling
  * [Color Scheme](https://github.com/AmazingRise/hugo-theme-diary/wiki/Customization#change-color-scheme)
  * [Code Highlight](https://github.com/AmazingRise/hugo-theme-diary/wiki/Customization#about-highlight)
  * [Font Family](https://github.com/AmazingRise/hugo-theme-diary/wiki/Customization#change-default-font-scheme)
  * [Reading Time](https://github.com/AmazingRise/hugo-theme-diary/wiki/Reading-Time)
  * [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

![](https://raw.githubusercontent.com/AmazingRise/hugo-theme-diary/master/images/tn.png)

An essay with picture.

![](https://raw.githubusercontent.com/AmazingRise/hugo-theme-diary/master/images/essay.png)

Table of Contents with scroll spy.

![](https://raw.githubusercontent.com/AmazingRise/hugo-theme-diary/master/images/essay2.png)

Mobile View: Main Page

![](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)