1
0
mirror of https://github.com/cotes2020/jekyll-theme-chirpy.git synced 2025-12-18 05:41:31 +00:00

Fixed the Docs.

This commit is contained in:
Cotes Chung
2020-03-30 07:34:39 +08:00
parent 8f0c3659d6
commit 9f6173231b
5 changed files with 27 additions and 17 deletions

View File

@@ -46,8 +46,8 @@ jekyll-theme-chirpy
├── categories
│   ├── animal.html
│   └── tutorial.html
── tags
  └── bee.html
── tags
  └── bee.html
```
and the content of a *category* type page is
@@ -64,11 +64,24 @@ category: CATEGORY_NAME # e.g. Insect
---
layout: tag
title: TAG_NAME # e.g. bee
category: TAG_NAME # e.g. bee
tag: TAG_NAME # e.g. bee
---
```
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 }}).
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 }}).
- **Last modified date**
The last modified date of the posts is recorded as `seo.date_modified`, for example:
```yaml
---
seo:
date_modified: 2020-01-04 17:05:41 +0800
---
```
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.
## Table of Contents

View File

@@ -77,7 +77,7 @@ Basically, go to `_config.yml` and customize the variables as needed, some of th
* `url`
Set to your website domain and there should be no slash symbol at the tail.
Set to your website url and there should be no slash symbol at the tail. Format: `<protocol>://<domain>`.
* `avatar`