Skip to content

Commit 1a82b89

Browse files
committed
Update README
1 parent d84dd10 commit 1a82b89

File tree

1 file changed

+5
-34
lines changed

1 file changed

+5
-34
lines changed

README.md

Lines changed: 5 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
# Chirpy Starter
1+
# Chirpy Starter [![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy)](https://rubygems.org/gems/jekyll-theme-chirpy) [![GitHub license](https://img.shields.io/github/license/cotes2020/chirpy-starter.svg?color=blue)][mit]
22

3-
[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy)](https://rubygems.org/gems/jekyll-theme-chirpy)
4-
[![GitHub license](https://img.shields.io/github/license/cotes2020/chirpy-starter.svg?color=blue)][mit]
53

64
The startup template for [**Jekyll Theme Chirpy**][chirpy].
75

@@ -32,46 +30,19 @@ $ bundle
3230

3331
## Usage
3432

35-
### Customing Stylesheet
33+
Please see the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#usage).
3634

37-
Creare a new file `/assets/css/style.scss` in your Jekyll site.
35+
## Upgrading
3836

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"`).
6538

6639
After that, execute the following command:
6740

6841
```console
6942
$ bundle update jekyll-theme-chirpy
7043
```
7144

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.
7546

7647
## License
7748

0 commit comments

Comments
 (0)