Skip to content

Commit 8dd4888

Browse files
committed
Fixed the Docs.
1 parent 82c1c26 commit 8dd4888

File tree

5 files changed

+27
-17
lines changed

5 files changed

+27
-17
lines changed

Diff for: README.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77
Language: English | [简体中文](docs/README_zh-CN.md)
88

9-
A minimal, portfolio, sidebar, bootstrap Jekyll theme with responsive web design and focuses on text exhibition. It will help you easily record, manage and share your knowledge and experience.
9+
A minimal, portfolio, sidebar, bootstrap Jekyll theme with responsive web design and focuses on text exhibition. It will help you easily record and share your knowledge.
1010

11-
You will get the following features:
11+
**Features**
1212

1313
* Auto Dark Mode
1414
* Posts' Last Modified Date
@@ -24,9 +24,7 @@ You will get the following features:
2424
* SEO Tag
2525
* Performance Optimization
2626

27-
[**Live Demo** »](https://chirpy.cotes.info)
28-
29-
![devices-mockup](https://raw.githubusercontent.com/cotes2020/jekyll-theme-chirpy/master/assets/img/sample/devices-mockup.png)
27+
[![devices-mockup](https://raw.githubusercontent.com/cotes2020/jekyll-theme-chirpy/master/assets/img/sample/devices-mockup.png)](https://chirpy.cotes.info)
3028

3129
## Table of Contents
3230

@@ -124,7 +122,7 @@ Basically, go to `_config.yml` and customize the variables as needed, some of th
124122

125123
* `url`
126124

127-
Set to your website domain and there should be no slash symbol at the tail.
125+
Set to your website url and there should be no slash symbol at the tail. Format: `<protocol>://<domain>`.
128126

129127

130128
* `avatar`
@@ -242,7 +240,7 @@ For more details and the better reading experience, please check out the [tutori
242240

243241
## Contributing
244242

245-
The old saying: "Tow heads are better than one. Five heads are better than two." So, welcome to report bugs, improve code quality or submit a new feature. For more information, see [contributing guidelines](.github/CONTRIBUTING.md).
243+
The old saying: "Two heads are better than one. Five heads are better than two." So, welcome to report bugs, improve code quality or submit a new feature. For more information, see [contributing guidelines](.github/CONTRIBUTING.md).
246244

247245

248246
## Credits
@@ -254,7 +252,7 @@ This theme is mainly built with [Jekyll](https://jekyllrb.com/) ecosystem, [Boot
254252

255253
## Support
256254

257-
If you enjoy this theme or find it helpful, please consider becoming my sponsor, I'd really appreciate it! Click the button <kbd>:heart:Sponsor</kbd> at the top of the [Home Page](https://github.com/cotes2020/jekyll-theme-chirpy) and choose a link that suits you to donate. This will encourage me and help me maintain this project.
255+
If you enjoy this theme or find it helpful, please consider becoming my sponsor, I'd really appreciate it! Click the button <kbd>:heart:Sponsor</kbd> at the top of the [Home Page](https://github.com/cotes2020/jekyll-theme-chirpy) and choose a link that suits you to donate; this will encourage and help me better maintain the project.
258256

259257

260258
## License

Diff for: _config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ description: >- # used by seo meta and the atom feed
1717
bootstrap Jekyll theme with responsive web design
1818
and focuses on text presentation.
1919
20-
# Replace with your domain, e.g. 'https://username.github.io'
20+
# Replace with the website url, e.g. 'https://username.github.io'
2121
url: 'protocol://domain'
2222

2323
author: your_full_name # change to your full name

Diff for: _posts/2019-08-08-write-a-new-post.md

+17-4
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ jekyll-theme-chirpy
4646
├── categories
4747
│   ├── animal.html
4848
│   └── tutorial.html
49-
── tags
50-
  └── bee.html
49+
── tags
50+
  └── bee.html
5151
```
5252

5353
and the content of a *category* type page is
@@ -64,11 +64,24 @@ category: CATEGORY_NAME # e.g. Insect
6464
---
6565
layout: tag
6666
title: TAG_NAME # e.g. bee
67-
category: TAG_NAME # e.g. bee
67+
tag: TAG_NAME # e.g. bee
6868
---
6969
```
7070

71-
With the increasing number of posts, the number of categories and tags will increase several times! If we still manually create these *category*/*tag* type files, it will obviously be a super time-consuming job, and it is very likely to miss some of them(i.e. when you click on the missing `category` or `tag` link from a post or somewhere, it will complain to you '404'). The good news is that we got a lovely script tool to finish the pages creation stuff: `tools/init.sh`. See its usage [here]({{ "/posts/getting-started/#option-1-built-by-github-pages" | relative_url }}).
71+
With the increasing number of posts, the number of categories and tags will increase several times! If we still manually create these *category*/*tag* type files, it will obviously be a super time-consuming job, and it is very likely to miss some of them(i.e. when you click on the missing `category` or `tag` link from a post or somewhere, it will complain to you '404'). The good news is that we got a lovely script tool `_scripts/py/pages_generator.py` to finish the boring task. Basically we will use it via `tools/init.sh` instead of running it separately. Check out its use case [here]({{ "/posts/getting-started/#option-1-built-by-github-pages" | relative_url }}).
72+
73+
- **Last modified date**
74+
75+
The last modified date of the posts is recorded as `seo.date_modified`, for example:
76+
```yaml
77+
---
78+
seo:
79+
date_modified: 2020-01-04 17:05:41 +0800
80+
---
81+
```
82+
83+
This date is equal to the lastest git-commit date of the post file and can be automatically generated by the tool script `_scripts/py/update_posts_lastmod.py`. Similar to the other script `pages_generator.py` mentioned above, it is also be called from `tools/init.sh`, so it doesn't have to be used separately.
84+
7285

7386
## Table of Contents
7487

Diff for: _posts/2019-08-09-getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Basically, go to `_config.yml` and customize the variables as needed, some of th
7777

7878
* `url`
7979

80-
Set to your website domain and there should be no slash symbol at the tail.
80+
Set to your website url and there should be no slash symbol at the tail. Format: `<protocol>://<domain>`.
8181

8282

8383
* `avatar`

Diff for: docs/README_zh-CN.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE)
55
[![996.icu](https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg)](https://996.icu)
66

7-
Language: [English](../README.md) | 简体中文
7+
选择语言: [English](../README.md) | 简体中文
88

99
一个不一样的 Jekyll 主题(内附神秘工具),采用响应式设计,方便记录、管理、分享你的知识和经验。
1010

@@ -24,9 +24,8 @@ Language: [English](../README.md) | 简体中文
2424
* SEO 优化
2525
* 网站性能优化
2626

27-
[**在线体验** »](https://chirpy.cotes.info)
2827

29-
![devices-mockup](https://raw.githubusercontent.com/cotes2020/jekyll-theme-chirpy/master/assets/img/sample/devices-mockup.png)
28+
[![devices-mockup](https://raw.githubusercontent.com/cotes2020/jekyll-theme-chirpy/master/assets/img/sample/devices-mockup.png)](https://chirpy.cotes.info)
3029

3130
## 目录
3231

0 commit comments

Comments
 (0)