Skip to content

Commit 6ab00c0

Browse files
committed
Update README.
1 parent 89b93bc commit 6ab00c0

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

Diff for: README.md

+28-4
Original file line numberDiff line numberDiff line change
@@ -122,14 +122,28 @@ As mentioned above, some files or directories should be removed from your repo:
122122

123123
Basically, go to `_config.yml` and customize the variables as needed, some of them are typical options:
124124

125-
* Avatar
125+
* `url`
126+
127+
Set to your website domain and there should be no slash symbol at the tail.
128+
129+
130+
* `avatar`
126131

127-
`avatar` defines the source image location. The sample image is `/assets/img/sample/avatar.jpg`. It should be replaced by your own one. Notice that a huge image file will increase the load time of your site, so keep your avatar size as samll as possible(may be *<https://tinypng.com/>* will help).
132+
It defines the image file location of avatar. The sample image is `/assets/img/sample/avatar.jpg`, and should be replaced by your own one(a square image). Notice that a huge image file will increase the load time of your site, so keep your avatar image size as samll as possible(may be *<https://tinypng.com/>* will help).
128133

129-
* TimeZone
134+
* `timezone`
130135

131136
To ensure that the posts' release date matches the city you live in, please modify the field `timezone` correctly. A list of all available values can be found on [TimezoneConverter](http://www.timezoneconverter.com/cgi-bin/findzone/findzone) or [Wikipedia](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
132137

138+
* `theme_mode`
139+
140+
There are three options for the theme color scheme:
141+
142+
- **dual** - The default color scheme will follow the system settings, but if the system does not support dark mode, or the browser does not support `Media Queries Level 5`, the theme will be displayed as `light` mode by default. Anyway, the bottom left corner of the Sidebar will provide a button for users to switch color schemes.
143+
144+
- **dark** - Always show dark mode.
145+
- **light** - Always show light mode.
146+
133147

134148
### Run Locally
135149

@@ -168,7 +182,17 @@ $ bash tools/init.sh
168182

169183
>**Note**: The *Recent Update* requires the posts' latest git-log date, so make sure the changes in `_posts` have been committed before running this command.
170184
171-
it will automatically generates the *Latest Modified Date* and *Categories / Tags* page for the posts.
185+
it will automatically generates the *Latest Modified Date* and *Categories / Tags* page for the posts and submit a commit. Its output is similar to the following log:
186+
187+
```terminal
188+
[INFO] Success to update lastmod for 4 post(s).
189+
[INFO] Succeed! 3 category-pages created.
190+
[INFO] Succeed! 4 tag-pages created.
191+
[Automation] Updated the Categories, Tags, Lastmod for post(s).
192+
11 files changed, 46 insertions(+), 3 deletions(-)
193+
...
194+
Updated the Categories, Tags, Lastmod for post(s).
195+
```
172196

173197
**3**. Push the changes to `origin/master` then go to GitHub website and enable GitHub Pages service for the repo.
174198

0 commit comments

Comments
 (0)