Skip to content

Commit c476f9c

Browse files
committed
Update tutorial on demo site.
1 parent c199d51 commit c476f9c

1 file changed

Lines changed: 30 additions & 5 deletions

File tree

_posts/2019-08-09-getting-started.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,16 +73,30 @@ As mentioned above, some files or directories should be removed from your repo:
7373

7474
## Configuration
7575

76-
Customize the variables in file `_config.yml` as needed.
76+
Basically, go to `_config.yml` and customize the variables as needed, some of them are typical options:
7777

78-
* Avatar
78+
* `url`
7979

80-
The sample avatar 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).
80+
Set to your website domain and there should be no slash symbol at the tail.
8181

82-
* TimeZone
82+
83+
* `avatar`
84+
85+
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).
86+
87+
* `timezone`
8388

8489
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).
8590

91+
* `theme_mode`
92+
93+
There are three options for the theme color scheme:
94+
95+
- **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.
96+
97+
- **dark** - Always show dark mode.
98+
- **light** - Always show light mode.
99+
86100

87101
## Run Locally
88102

@@ -122,7 +136,18 @@ $ bash tools/init.sh
122136

123137
> Please note that the *Recent Update* list requires the latest git-log date of posts, thus make sure the changes in `_posts` have been committed before running this command.
124138
125-
it will automatically generates the *Latest Modified Date* and *Categories / Tags* page for the posts.
139+
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:
140+
141+
```terminal
142+
[INFO] Success to update lastmod for 4 post(s).
143+
[INFO] Succeed! 3 category-pages created.
144+
[INFO] Succeed! 4 tag-pages created.
145+
[Automation] Updated the Categories, Tags, Lastmod for post(s).
146+
11 files changed, 46 insertions(+), 3 deletions(-)
147+
...
148+
Updated the Categories, Tags, Lastmod for post(s).
149+
```
150+
126151

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

0 commit comments

Comments
 (0)