jekyll-theme-chirpy 4.3.1 → 4.3.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +15 -15
- data/_config.yml +2 -2
- data/_includes/search-loader.html +1 -1
- data/_sass/jekyll-theme-chirpy.scss +1 -1
- data/assets/js/data/search.json +1 -1
- data/assets/js/dist/categories.min.js +1 -1
- data/assets/js/dist/commons.min.js +1 -1
- data/assets/js/dist/home.min.js +1 -1
- data/assets/js/dist/page.min.js +1 -1
- data/assets/js/dist/post.min.js +1 -1
- data/assets/js/dist/pvreport.min.js +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: db155a6027d2ec69a95ad86d5f82d498b263d102a1a56f709af7d9f6cdcbc239
|
|
4
|
+
data.tar.gz: 6ccca8e3934be59b58b19c796620012714c70a82b3c86adfbd6db8851c52303f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b602f22c0d0b595ebf5783db5c37c637d820abddb927deb8caf89c6732513d86d09e1ceb60a4fa69d753b67006969ef35dceb38f731648f5bab5e6f0ab22d0c1
|
|
7
|
+
data.tar.gz: 8901ce98ae59d28f20416b07ac4d454793a3a3b5ad21317933de5b06a0aacc860ffa8f68aa94dd02c5052b31b18db8d00b1ee7b3c7324a1557b678ebbf16515c
|
data/README.md
CHANGED
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
|
|
18
18
|
A minimal, responsive, and powerful Jekyll theme for presenting professional writing.
|
|
19
19
|
|
|
20
|
-
**
|
|
20
|
+
[**Live Demo →**](https://chirpy.cotes.info)
|
|
21
21
|
|
|
22
22
|
[](https://chirpy.cotes.info)
|
|
23
23
|
|
|
@@ -44,7 +44,7 @@
|
|
|
44
44
|
|
|
45
45
|
## Prerequisites
|
|
46
46
|
|
|
47
|
-
Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll
|
|
47
|
+
Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll`, and `Bundler`.
|
|
48
48
|
|
|
49
49
|
## Installation
|
|
50
50
|
|
|
@@ -52,9 +52,8 @@ Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installat
|
|
|
52
52
|
|
|
53
53
|
There are two ways to create a new repository for this theme:
|
|
54
54
|
|
|
55
|
-
- **
|
|
56
|
-
|
|
57
|
-
- **[Forking on GitHub](#option-2-forking-on-github)** - Convenient for custom development, but difficult to upgrade. Unless you are familiar with Jekyll and are determined to tweak or contribute to this project, this approach is not recommended.
|
|
55
|
+
- [**Using the Chirpy Starter**](#option-1-using-the-chirpy-starter) - Easy to upgrade, isolates irrelevant project files so you can focus on writing.
|
|
56
|
+
- [**Forking on GitHub**](#option-2-forking-on-github) - Convenient for custom development, but difficult to upgrade. Unless you are familiar with Jekyll and are determined to tweak or contribute to this project, this approach is not recommended.
|
|
58
57
|
|
|
59
58
|
#### Option 1. Using the Chirpy Starter
|
|
60
59
|
|
|
@@ -62,7 +61,7 @@ Create a new repository from the [**Chirpy Starter**][use-starter] and name it `
|
|
|
62
61
|
|
|
63
62
|
#### Option 2. Forking on GitHub
|
|
64
63
|
|
|
65
|
-
[Fork **Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/fork) on GitHub and rename it to `<GH_USERNAME>.github.io`. Please note that the default branch code is in development. If you want the site to be stable, please switch to the [latest tag]
|
|
64
|
+
[Fork **Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/fork) on GitHub and rename it to `<GH_USERNAME>.github.io`. Please note that the default branch code is in development. If you want the site to be stable, please switch to the [latest tag][latest-tag] and start writing.
|
|
66
65
|
|
|
67
66
|
And then execute:
|
|
68
67
|
|
|
@@ -79,7 +78,7 @@ The above command will:
|
|
|
79
78
|
- files under `_posts`
|
|
80
79
|
- folder `docs`
|
|
81
80
|
|
|
82
|
-
2. If the option `--no-gh` is provided, the directory `.github` will be deleted. Otherwise,
|
|
81
|
+
2. If the option `--no-gh` is provided, the directory `.github` will be deleted. Otherwise, set up the GitHub Action workflow by removing the extension `.hook` of `.github/workflows/pages-deploy.yml.hook`, and then remove the other files and directories in the folder `.github`.
|
|
83
82
|
|
|
84
83
|
3. Removes item `Gemfile.lock` from `.gitignore`.
|
|
85
84
|
|
|
@@ -87,7 +86,7 @@ The above command will:
|
|
|
87
86
|
|
|
88
87
|
### Installing Dependencies
|
|
89
88
|
|
|
90
|
-
Before running for the first time, go the root directory of your site, and install dependencies as follows:
|
|
89
|
+
Before running for the first time, go to the root directory of your site, and install dependencies as follows:
|
|
91
90
|
|
|
92
91
|
```console
|
|
93
92
|
$ bundle
|
|
@@ -106,7 +105,7 @@ Update the variables of `_config.yml` as needed. Some of them are typical option
|
|
|
106
105
|
|
|
107
106
|
### Customing Stylesheet
|
|
108
107
|
|
|
109
|
-
If you need to customize stylesheet, copy the theme's `assets/css/style.scss` to the same path on your Jekyll site, and then add the custom style at the end of the style file.
|
|
108
|
+
If you need to customize the stylesheet, copy the theme's `assets/css/style.scss` to the same path on your Jekyll site, and then add the custom style at the end of the style file.
|
|
110
109
|
|
|
111
110
|
Starting from [`v4.1.0`][chirpy-4.1.0], if you want to overwrite the SASS variables defined in `_sass/addon/variables.scss`, create a new file `_sass/variables-hook.scss` and assign new values to the target variable in it.
|
|
112
111
|
|
|
@@ -131,7 +130,7 @@ After a while, the local service will be published at _<http://127.0.0.1:4000>_.
|
|
|
131
130
|
|
|
132
131
|
### Deployment
|
|
133
132
|
|
|
134
|
-
Before the deployment begins,
|
|
133
|
+
Before the deployment begins, check out the file `_config.yml` and make sure the `url` is configured correctly. Furthermore, if you prefer the [**project site**](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites) and don't use a custom domain, or you want to visit your website with a base URL on a web server other than **GitHub Pages**, remember to change the `baseurl` to your project name that starts with a slash, e.g, `/project-name`.
|
|
135
134
|
|
|
136
135
|
Now you can choose ONE of the following methods to deploy your Jekyll site.
|
|
137
136
|
|
|
@@ -145,7 +144,7 @@ Quickly check the files needed for GitHub Actions build:
|
|
|
145
144
|
|
|
146
145
|
- Ensure your Jekyll site has file `tools/deploy.sh`. Otherwise, copy it from here to your Jekyll site.
|
|
147
146
|
|
|
148
|
-
- Furthermore, if you have committed `Gemfile.lock` to the repo, and your runtime system is not Linux, don't forget to update the platform list in the
|
|
147
|
+
- Furthermore, if you have committed `Gemfile.lock` to the repo, and your runtime system is not Linux, don't forget to update the platform list in the lock file:
|
|
149
148
|
|
|
150
149
|
```console
|
|
151
150
|
$ bundle lock --add-platform x86_64-linux
|
|
@@ -189,7 +188,8 @@ Unless you specified the output path, the generated site files will be placed in
|
|
|
189
188
|
|
|
190
189
|
It depends on how you use the theme:
|
|
191
190
|
|
|
192
|
-
- If you are using the theme gem (there will be `gem "jekyll-theme-chirpy"` in the `Gemfile`), editing the `Gemfile` and update the version number of the
|
|
191
|
+
- If you are using the theme gem (there will be `gem "jekyll-theme-chirpy"` in the `Gemfile`), editing the `Gemfile` and update the version number of the theme gem, for example:
|
|
192
|
+
|
|
193
193
|
```diff
|
|
194
194
|
- gem "jekyll-theme-chirpy", "~> 3.2", ">= 3.2.1"
|
|
195
195
|
+ gem "jekyll-theme-chirpy", "~> 3.3", ">= 3.3.0"
|
|
@@ -208,7 +208,7 @@ The merge is likely to conflict with your local modifications. Please be patient
|
|
|
208
208
|
|
|
209
209
|
## Documentation
|
|
210
210
|
|
|
211
|
-
For more details and a better reading experience, please check out the [tutorials on the demo site](https://chirpy.cotes.info/categories/tutorial/). In the meanwhile, a copy of the tutorial is also available on the [Wiki](https://github.com/cotes2020/jekyll-theme-chirpy/wiki). Please note that the tutorials on the demo website or Wiki are based on the latest release, and the features of `master` branch usually ahead of the documentation.
|
|
211
|
+
For more details and a better reading experience, please check out the [tutorials on the demo site](https://chirpy.cotes.info/categories/tutorial/). In the meanwhile, a copy of the tutorial is also available on the [Wiki](https://github.com/cotes2020/jekyll-theme-chirpy/wiki). Please note that the tutorials on the demo website or Wiki are based on the latest release, and the features of `master` branch are usually ahead of the documentation.
|
|
212
212
|
|
|
213
213
|
## Contributing
|
|
214
214
|
|
|
@@ -216,9 +216,9 @@ The old saying, "Two heads are better than one." Consequently, welcome to report
|
|
|
216
216
|
|
|
217
217
|
## Credits
|
|
218
218
|
|
|
219
|
-
This theme is mainly built with [Jekyll](https://jekyllrb.com/) ecosystem, [Bootstrap](https://getbootstrap.com/), [Font Awesome](https://fontawesome.com/) and some other wonderful tools (their copyright information can be found in the relevant files). The avatar and favicon design
|
|
219
|
+
This theme is mainly built with [Jekyll](https://jekyllrb.com/) ecosystem, [Bootstrap](https://getbootstrap.com/), [Font Awesome](https://fontawesome.com/) and some other wonderful tools (their copyright information can be found in the relevant files). The avatar and favicon design come from [Clipart Max](https://www.clipartmax.com/middle/m2i8b1m2K9Z5m2K9_ant-clipart-childrens-ant-cute/).
|
|
220
220
|
|
|
221
|
-
:tada: Thanks to all the volunteers who contributed to this project, their GitHub IDs are on [this list](https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors). Also, I won't forget those guys who submitted the issues or unmerged PR because they reported bugs, shared ideas
|
|
221
|
+
:tada: Thanks to all the volunteers who contributed to this project, their GitHub IDs are on [this list](https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors). Also, I won't forget those guys who submitted the issues or unmerged PR because they reported bugs, shared ideas or inspired me to write more readable documentation.
|
|
222
222
|
|
|
223
223
|
Last but not least, thank [JetBrains][jb] for providing the open source license.
|
|
224
224
|
|
data/_config.yml
CHANGED
|
@@ -79,10 +79,10 @@ theme_mode: # [light|dark]
|
|
|
79
79
|
# will be added to all image (site avatar & posts' images) paths starting with '/'
|
|
80
80
|
#
|
|
81
81
|
# e.g. 'https://cdn.com'
|
|
82
|
-
img_cdn:
|
|
82
|
+
img_cdn:
|
|
83
83
|
|
|
84
84
|
# the avatar on sidebar, support local or CORS resources
|
|
85
|
-
avatar:
|
|
85
|
+
avatar:
|
|
86
86
|
|
|
87
87
|
# boolean type, the global switch for ToC in posts.
|
|
88
88
|
toc: true
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
{% capture result_elem %}
|
|
7
7
|
<div class="pl-1 pr-1 pl-sm-2 pr-sm-2 pl-lg-4 pr-lg-4 pl-xl-0 pr-xl-0">
|
|
8
|
-
<a href="{
|
|
8
|
+
<a href="{url}">{title}</a>
|
|
9
9
|
<div class="post-meta d-flex flex-column flex-sm-row text-muted mt-1 mb-1">
|
|
10
10
|
{categories}
|
|
11
11
|
{tags}
|
data/assets/js/data/search.json
CHANGED
|
@@ -6,7 +6,7 @@ layout: compress
|
|
|
6
6
|
{% for post in site.posts %}
|
|
7
7
|
{
|
|
8
8
|
"title": "{{ post.title | escape }}",
|
|
9
|
-
"url": "{{
|
|
9
|
+
"url": "{{ post.url | relative_url }}",
|
|
10
10
|
"categories": "{{ post.categories | join: ', '}}",
|
|
11
11
|
"tags": "{{ post.tags | join: ', ' }}",
|
|
12
12
|
"date": "{{ post.date }}",
|
data/assets/js/dist/home.min.js
CHANGED
data/assets/js/dist/page.min.js
CHANGED
data/assets/js/dist/post.min.js
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-theme-chirpy
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 4.3.
|
|
4
|
+
version: 4.3.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Cotes Chung
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2021-10-
|
|
11
|
+
date: 2021-10-14 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: jekyll
|