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: 2c835659d9116071ea750a0c59361bfaf3a913c7 (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
# hugo-theme-diary
![](https://img.shields.io/badge/license-MIT-blue.svg)
[Live Demo](https://amazingrise.net/hugo-theme-diary/)

Original Author: [SumiMakito](https://github.com/SumiMakito)

隻言片語・於此匯聚

Moments piled up.
---

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

Hereinafter referred to the original version made by SumiMakito as `the ori`.

This theme is [under construction](https://github.com/AmazingRise/hugo-theme-diary/projects/2).

## Screenshots

[Live Demo here!](https://amazingrise.net/hugo-theme-diary/)

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

Site Main Page

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

An essay with picture.

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

Mobile Main Page

## Features

Features in the ori.:

- Simple and easy to customize
- Concentrated on reading <del>and writing (find a Markdown editor then)</del> experience
- Mobile-friendly & widescreen-friendly
- Flexible commenting control

Features in this ported version:

- Add support for gitalk.
- Tag & category page appending more easily.
- Customizable color scheme. (Some bug in original version, fixed.)
- Firefox-friendly. (CSS issue in original version, fixed.)
- `featured_image` url bug is fixed.

## 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 ../..
```
## Using & Customize

As for other details, please visit [the project wiki](https://github.com/amazingrise/hugo-theme-diary/wiki) for details.

[How to change color scheme?](https://github.com/AmazingRise/hugo-theme-diary/wiki/Customization#change-color-scheme)
[How to add or disable comment area?](https://github.com/AmazingRise/hugo-theme-diary/wiki/Customization#add-comment-area)

### Example config

Here is an example config. (The same as `/exampleSite/config.toml`)
```
baseURL = "http://example.org/"
languageCode = "en-us"
title = "A Hugo Site"
copyright = "This is a customized copyright."

theme = "diary"
# googleAnalytics = "UA-123-45"

[params]
subtitle = "Themed by Diary."
enableGitalk = true

[params.gitalk]
  owner = "user"
  repo = "repo name"
  client_id = "your client id"
  client_secret = "your client secret"
[taxonomies]
   tag = "tags"
   category = "categories"
```

## Comparison

For details about the difference lies in the new version, please click [here.](https://github.com/AmazingRise/hugo-theme-diary/wiki/Comparison)