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

README.md - github.com/ertuil/erblog.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: ae35c98970e8e055df4c9e38c5735f5dae2b5eb5 (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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
# Erblog

A personal blog theme powered by [Hugo](https://gohugo.io).
Erblog is written by Ertuil with [layui.js](https://www.layui.com), [font-awssome](https://fontawesome.com),github markdown css  and [undraw](https://undraw.co).

Erblog is also a responsive theme which means it is customed for your mobile platforms.

![images/tn.png](https://raw.githubusercontent.com/ertuil/erblog/master/images/tn.png)

![images/list.png](https://raw.githubusercontent.com/ertuil/erblog/master/images/list.png)

![images/single.png](https://raw.githubusercontent.com/ertuil/erblog/master/images/single.png)

## 1. Installation

You can install the theme by git clone.

```
$ git submodule add https://github.com/ertuil/erblog themes/erblog
$ git submodule init
$ git submodule update
```

Now you can get updates to Erblog in the future by updating the submodule:

```
$ git submodule update --remote themes/erblog
```

> [@progressify](https://github.com/progressify) contributed a new style for scrollbar. You can check out the branch called [https://github.com/ertuil/erblog/tree/styled-scrollbar](https://github.com/ertuil/erblog/tree/styled-scrollbar) to use. Here is an example:
> [https://progressify.dev](https://progressify.dev)
> Thanks to his contribution.

## 2. Configuration

There are some basic configuration options you may want to use:

| Name | Description | Default |
| ---- | ---- | ---- |
| title | Name of your website | None |
| googleAnalytics | Google Analytics ID| None |
| Params.portrait | The protrait file | erblog/static/self/img/avater.jpg |
| Params.author | Your Name | 'Authors' |
| Params.description | A simple description | 'Intro' |
| Params.bio | Your biological description | None |
| Params.logo | The logo file | None |
| Params.favicon | The favicon file | "/favicon.ico" |

Alse you can add your own custom menus in `config.toml` like this:

```
[[menu.main]]
    url = "/home/"
    name = "Files"
    weight = 6

[[menu.main]]
    url = "/dl/"
    name = "Download"
    weight = 7
```

A Menu in the footer is also available:

```
[[menu.footer]]
    identifier = "home"
    name = "home"
    url = "/"
    weight = 1

[[menu.footer]]
    identifier = "about"
    name = "About"
    url = "/about/"
    weight = 2
```

Now you can add your contacts like this:

```
# Social icons to be shown on the right-hand side of the navigation bar
# The "name" field should match the name of the icon to be used
# The list of available icons can be found at http://fontawesome.io/icons/

[[menu.icon]]
    url = "mailto:me@xxx.com"
    name = "envelope-o"
    weight = 1

[[menu.icon]]
    url = "https://github.com/username/"
    name = "github"
    weight = 1

[[menu.icon]]
    url = "https://twitter.com/username"
    name = "twitter"
    weight = 1

[[menu.icon]]
    url = "https://www.instagram.com/username/"
    name = "instagram"
    weight = 1
```

For more details, see exampleSite.

## 3. Content Management

### 3.1 Posts

There are three basic sections, 'post', 'zone' and 'gallery'. You may create a new post using the following command:

```
hugo new post/post_name.md
```

### 3.2 Zone

A section like facebook

![images/zone.png](https://raw.githubusercontent.com/ertuil/erblog/master/images/zone.png)

```
hugo new zone/example.md
```

### 3.3 Gallery

Gallery is a simple collection for your photos.

![images/gallery.png](https://raw.githubusercontent.com/ertuil/erblog/master/images/gallery.png)

```
hugo new gallery/gallery_name.md
```

You can upload your files to `/static` directory and write these contents in `gallery_name.md`:

```
---
title: "A gallery"
date: 2019-12-01T13:21:53+08:00
draft: false
---

![0](/avater.jpg)
![1](/people/1.png)
![2](/people/2.png)
![3](/people/3.png)
```

### 3.4 Add zone and gallery to menu

Add the following content to your `config.toml`

```toml
[[menu.main]]
    url = "/zone/"
    name = "Zone"
    weight = 1

[[menu.main]]
    url = "/gallery/"
    name = "Gallery"
    weight = 2
```

## 4. Self-Define HTML hook
There are tow hooks available for you to insert your HTML codes.

The first is `layouts/partials/self-define.html` which is located above the footer in all pages.

The first is `layouts/partials/self-define-single.html`. It is useful to define your `comment modules` such as gittalk. It is below the major section of your articles of each pages.