jekyll-theme-chirpy 3.0.1 → 3.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +11 -7
- data/_includes/footer.html +2 -1
- data/_sass/jekyll-theme-chirpy.scss +1 -1
- data/assets/js/dist/categories.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 +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 13329c76cf9ab970bac6aed0bbd902c7d22257353ffb69a46d19ce9f8f1e8169
|
|
4
|
+
data.tar.gz: be8f748d386097bb471cf4e30e094bfaa8868e7db702a149e7320249605e928b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7c2a11fa5d473856d36e464103d186d33624acbea23139d2a2378032eaf60d52bfc9382ea59bbfe64f44ad2c8a3afb4755370a5bc8a0dbc99af2cf333d4010e8
|
|
7
|
+
data.tar.gz: 000eb0bad0b453aadcd5ea4bb629fdaab0a76850368225e6110b341d6bf7348042bcbdd5c6e522487ee7867492e55f9987866fec97e9ec9366545cfc4ffa4479
|
data/README.md
CHANGED
|
@@ -40,7 +40,6 @@ A minimal, sidebar, responsive web design Jekyll theme that focuses on text pres
|
|
|
40
40
|
- GA Pageviews reporting (Advanced)
|
|
41
41
|
- SEO and Performance Optimization
|
|
42
42
|
|
|
43
|
-
|
|
44
43
|
## Prerequisites
|
|
45
44
|
|
|
46
45
|
Follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll` and `Bundler`.
|
|
@@ -72,7 +71,7 @@ And then execute:
|
|
|
72
71
|
$ bundle
|
|
73
72
|
```
|
|
74
73
|
|
|
75
|
-
Finally, copy the
|
|
74
|
+
Finally, copy the extra files (refer to the [starter project][starter] for the detailed file directory structure) from the theme's gem to your Jekyll site, and append all the variables of the theme's `_config.yml` to your Jekyll site.
|
|
76
75
|
|
|
77
76
|
> **Hint**: To locate the theme’s gem, execute:
|
|
78
77
|
>
|
|
@@ -115,6 +114,7 @@ What it does is:
|
|
|
115
114
|
|
|
116
115
|
3. Automatically create a commit to save the changes.
|
|
117
116
|
|
|
117
|
+
|
|
118
118
|
## Usage
|
|
119
119
|
|
|
120
120
|
### Configuration
|
|
@@ -149,20 +149,23 @@ Open a browser and visit to _<http://localhost:4000>_.
|
|
|
149
149
|
|
|
150
150
|
Before the deployment begins, checkout 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 starting with a slash, e.g, `/project-name`.
|
|
151
151
|
|
|
152
|
-
Now you can
|
|
152
|
+
Now you can choose ONE of the following methods to deploy your Jekyll site.
|
|
153
153
|
|
|
154
154
|
#### Deploy on GitHub Pages
|
|
155
155
|
|
|
156
156
|
For security reasons, GitHub Pages build runs on `safe` mode, which restricts us from using plugins to generate additional page files. Therefore, we can use **GitHub Actions** to build the site, store the built site files on a new branch, and use that branch as the source of the GH Pages service.
|
|
157
157
|
|
|
158
|
-
|
|
159
|
-
|
|
158
|
+
Quickly check the files needed for GitHub Actions build:
|
|
159
|
+
|
|
160
|
+
1. Ensure your Jekyll site has the file `/.github/workflows/pages-deploy.yml`. Otherwise, create a new one and fill in the contents of the [workflow file][workflow], and the value of the `on.push.branches` should be the same as your repo's default branch name.
|
|
161
|
+
|
|
162
|
+
2. Ensuer your Jekyll site has file `/tools/test.sh` and `/tools/deploy.sh`. Otherwise, copy them from this repo to your Jekyll site.
|
|
160
163
|
|
|
161
164
|
[workflow]:https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/workflows/pages-deploy.yml.hook
|
|
162
165
|
|
|
163
|
-
|
|
166
|
+
Next, rename your repoistory to `<GH-USERNAME>.github.io` on GitHub.
|
|
164
167
|
|
|
165
|
-
And then publish your site by:
|
|
168
|
+
And then publish your Jekyll site by:
|
|
166
169
|
|
|
167
170
|
1. Push any commit to remote to trigger the GitHub Actions workflow. Once the build is complete and successful, a new remote branch named `gh-pages` will appear to store the built site files.
|
|
168
171
|
|
|
@@ -194,6 +197,7 @@ $ docker run -it --rm \
|
|
|
194
197
|
|
|
195
198
|
Unless you specified the output path, the generated site files will be placed in folder `_site` of the project's root directory. Now you should upload those files to your web server.
|
|
196
199
|
|
|
200
|
+
|
|
197
201
|
## Documentation
|
|
198
202
|
|
|
199
203
|
For more details and the better reading experience, please check out the [tutorials on 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).
|
data/_includes/footer.html
CHANGED
|
@@ -20,7 +20,8 @@
|
|
|
20
20
|
Powered by
|
|
21
21
|
<a href="https://jekyllrb.com" target="_blank" rel="noopener">Jekyll</a>
|
|
22
22
|
with
|
|
23
|
-
<a href="
|
|
23
|
+
<a href="https://github.com/cotes2020/jekyll-theme-chirpy"
|
|
24
|
+
target="_blank" rel="noopener">Chirpy</a>
|
|
24
25
|
theme.
|
|
25
26
|
</p>
|
|
26
27
|
</div>
|
data/assets/js/dist/home.min.js
CHANGED
data/assets/js/dist/page.min.js
CHANGED
data/assets/js/dist/post.min.js
CHANGED