|
1 | | -# Chirpy Starter |
| 1 | +# Chirpy Starter [](https://rubygems.org/gems/jekyll-theme-chirpy) [][mit] |
2 | 2 |
|
3 | | -[](https://rubygems.org/gems/jekyll-theme-chirpy) |
4 | | -[][mit] |
5 | 3 |
|
6 | 4 | The startup template for [**Jekyll Theme Chirpy**][chirpy]. |
7 | 5 |
|
@@ -32,46 +30,19 @@ $ bundle |
32 | 30 |
|
33 | 31 | ## Usage |
34 | 32 |
|
35 | | -### Customing Stylesheet |
| 33 | +Please see the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#usage). |
36 | 34 |
|
37 | | -Creare a new file `/assets/css/style.scss` in your Jekyll site. |
| 35 | +## Upgrading |
38 | 36 |
|
39 | | -And then add the following content: |
40 | | - |
41 | | -```scss |
42 | | ---- |
43 | | ---- |
44 | | - |
45 | | -@import "{{ site.theme }}"; |
46 | | - |
47 | | -// add your style below |
48 | | -``` |
49 | | - |
50 | | -### Changing the Number of Tabs |
51 | | - |
52 | | -When adding or deleting files in the `_tabs` folder, you need to complete the section [Customing Stylesheet](#customing-stylesheet) first, and then add a new line before `@import`: |
53 | | - |
54 | | -```scss |
55 | | -$tab-count: {{ site.tabs | size | plus: 1 }}; |
56 | | -``` |
57 | | - |
58 | | -### Publishing to GitHub Pages |
59 | | - |
60 | | -See the [deployment instructions](https://github.com/cotes2020/jekyll-theme-chirpy#deployment) of `jekyll-theme-chirpy`. |
61 | | - |
62 | | -### Upgrading |
63 | | - |
64 | | -First, please modify the target version number of `jekyll-theme-chirpy` in the `Gemfile` (e.g., `gem "jekyll-theme-chirpy", "~> 4.0", ">= 4.0.1"`). In addition, if the major version number is updated, you need to update the critical files to keep them the same as this project. |
| 37 | +First, please modify the target version number of `jekyll-theme-chirpy` in the `Gemfile` (e.g., `gem "jekyll-theme-chirpy", "~> 4.0", ">= 4.0.1"`). |
65 | 38 |
|
66 | 39 | After that, execute the following command: |
67 | 40 |
|
68 | 41 | ```console |
69 | 42 | $ bundle update jekyll-theme-chirpy |
70 | 43 | ``` |
71 | 44 |
|
72 | | -## Documentation |
73 | | - |
74 | | -See the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#documentation). |
| 45 | +As the version upgrades, the critical files and configuration options will change. Please refer to the [Upgrade Guide](https://github.com/cotes2020/jekyll-theme-chirpy/wiki/Upgrade-Guide) to keep your website files in sync with the latest version of the theme. |
75 | 46 |
|
76 | 47 | ## License |
77 | 48 |
|
|
0 commit comments