You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,23 +39,23 @@
39
39
40
40
## Quick Start
41
41
42
-
Before starting, please follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll`, and `Bundler`. In addition, [Git](https://git-scm.com/)is also required to be installed.
42
+
Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of the basic environment. [Git](https://git-scm.com/) also needs to be installed.
43
43
44
44
### Step 1. Creating a New Site
45
45
46
-
Create a new repository from the [**Chirpy Starter**](https://github.com/cotes2020/chirpy-starter/generate)and name it `<GH_USERNAME>.github.io`, where `GH_USERNAME` represents your GitHub username.
46
+
Sign in to GitHub and browse to [**Chirpy Starter**](https://github.com/cotes2020/chirpy-starter/), click the button <kbd>Use this template</kbd> > <kbd>Create a new repository</kbd>, and name the new repository `USERNAME.github.io`, where `USERNAME` represents your GitHub username.
47
47
48
48
### Step 2. Installing Dependencies
49
49
50
-
Before running for the first time, go to the root directory of your site, and install dependencies as follows:
50
+
Clone it to your local machine, go to its root directory, and run the following command to install the dependencies.
51
51
52
52
```console
53
53
$ bundle
54
54
```
55
55
56
56
### Step 3. Running Local Server
57
57
58
-
Run the following command in the root directory of the site:
58
+
Run the following command in the root directory of your site:
59
59
60
60
```console
61
61
$ bundle exec jekyll s
@@ -70,11 +70,11 @@ $ docker run -it --rm \
70
70
jekyll serve
71
71
```
72
72
73
-
After a while, navigate to the site at <http://localhost:4000>.
73
+
After a few seconds, the local service will be published at _<http://127.0.0.1:4000>_.
74
74
75
75
## Documentation
76
76
77
-
For more details on usage, please refer to the tutorial on the [demo website](https://cotes2020.github.io/chirpy-demo/)/[wiki](https://github.com/cotes2020/jekyll-theme-chirpy/wiki). Note that the tutorial is based on the [latest release](https://github.com/cotes2020/jekyll-theme-chirpy/releases/latest), and the features of the default branch are usually ahead of the documentation.
77
+
For more details on usage, please refer to the tutorial on the [demo website](https://cotes2020.github.io/chirpy-demo/)or[wiki](https://github.com/cotes2020/jekyll-theme-chirpy/wiki). Note that the tutorial is based on the [latest release](https://github.com/cotes2020/jekyll-theme-chirpy/releases/latest), and the features of the default branch are usually ahead of the documentation.
78
78
79
79
## Contributing
80
80
@@ -90,7 +90,7 @@ Last but not least, thank [JetBrains][jb] for providing the OSS development lice
90
90
91
91
## Sponsoring
92
92
93
-
If you like this theme or find it helpful, please consider sponsoring me, because it will encourage and help me better maintain the project, I will be very grateful!
93
+
If you like it, please consider sponsoring me. It will help me to maintain this project better and I would be very grateful!
> For an SVG, you have to at least specify its _width_, otherwise it won't be rendered.
144
+
{: .prompt-info }
145
+
143
146
Starting from _Chirpy v5.0.0_, `height` and `width` support abbreviations (`height` → `h`, `width` → `w`). The following example has the same effect as the above:
Copy file name to clipboardExpand all lines: _posts/2019-08-09-getting-started.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ pin: true
9
9
10
10
## Prerequisites
11
11
12
-
Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll`, and `Bundler`. In addition, [Git](https://git-scm.com/)is also required to be installed.
12
+
Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of the basic environment. [Git](https://git-scm.com/) also needs to be installed.
13
13
14
14
## Installation
15
15
@@ -22,11 +22,11 @@ There are two ways to create a new repository for this theme:
22
22
23
23
#### Option 1. Using the Chirpy Starter
24
24
25
-
Create a new repository from the [**Chirpy Starter**][use-starter]and name it `<GH_USERNAME>.github.io`, where `GH_USERNAME` represents your GitHub username.
25
+
Sign in to GitHub and browse to [**Chirpy Starter**](https://github.com/cotes2020/chirpy-starter/), click the button <kbd>Use this template</kbd> > <kbd>Create a new repository</kbd>, and name the new repository `USERNAME.github.io`, where `USERNAME` represents your GitHub username.
26
26
27
27
#### Option 2. Forking on GitHub
28
28
29
-
[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.
29
+
[Fork **Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/fork) on GitHub and rename it to `USERNAME.github.io`. Note that the default branch code is under development. To ensure the stability of your site, please switch to the [latest tag][latest-tag] and start writing.
30
30
31
31
And then execute:
32
32
@@ -93,31 +93,32 @@ $ docker run -it --rm \
93
93
jekyll serve
94
94
```
95
95
96
-
After a while, the local service will be published at _<http://127.0.0.1:4000>_.
96
+
After a few seconds, the local service will be published at _<http://127.0.0.1:4000>_.
97
97
98
98
## Deployment
99
99
100
100
Before the deployment begins, check out the file `_config.yml`{: .filepath} 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`.
101
101
102
-
Now you can choose ONE of the following methods to deploy your Jekyll site.
102
+
Now you can choose _ONE_ of the following methods to deploy your Jekyll site.
103
103
104
104
### Deploy by Using GitHub Actions
105
105
106
-
Ensure your Jekyll site has the file `.github/workflows/pages-deploy.yml`{: .filepath}. Otherwise, create a new one and fill in the contents of the [sample file][workflow], and the value of the `on.push.branches` should be the same as your repo's default branch name. And then rename your repository to `<GH_USERNAME>.github.io` on GitHub.
106
+
There are a few things to get ready for.
107
107
108
-
Furthermore, if you have committed `Gemfile.lock`{: .filepath} to the repository and your local machine is not Linux, go the the root directory of your site and update the platform list:
108
+
- If you're on the GitHub Free plan, keep your site repository public.
109
+
- If you have committed `Gemfile.lock`{: .filepath} to the repository, and your local machine is not running Linux, go the the root of your site and update the platform list of the lock-file:
109
110
110
-
```console
111
-
$ bundle lock --add-platform x86_64-linux
112
-
```
111
+
```console
112
+
$ bundle lock --add-platform x86_64-linux
113
+
```
113
114
114
-
Now publish your Jekyll site:
115
+
Next, configure the _Pages_ service.
115
116
116
117
1. Browse to your repository on GitHub. Select the tab _Settings_, then click _Pages_ in the left navigation bar. Then, in the **Source** section (under _Build and deployment_), select [**GitHub Actions**][pages-workflow-src] from the dropdown menu.
117
118
118
-
2. Push any commit to remote to trigger the GitHub Actions workflow. In the _Actions_ tab of your repository, you should see the workflow _Build and Deploy_ running. Once the build is complete and successful, the site should be deployed automatically.
119
+
2. Push any commits to GitHub to trigger the _Actions_workflow. In the _Actions_ tab of your repository, you should see the workflow _Build and Deploy_ running. Once the build is complete and successful, the site will be deployed automatically.
119
120
120
-
3. Visit your website at the address indicated by GitHub.
121
+
At this point, you can go to the URL indicated by GitHub to access your site.
121
122
122
123
### Manually Build and Deploy
123
124
@@ -149,7 +150,7 @@ It depends on how you use the theme:
149
150
150
151
```diff
151
152
- gem "jekyll-theme-chirpy", "~> 3.2", ">= 3.2.1"
152
-
+ gem "jekyll-theme-chirpy", "~> 3.3", ">= 3.3.0"
153
+
+ gem "jekyll-theme-chirpy", "~> 4.3", ">= 4.3.2"
153
154
```
154
155
{: .nolineno file="Gemfile" }
155
156
@@ -165,7 +166,6 @@ It depends on how you use the theme:
165
166
The merge is likely to conflict with your local modifications. Please be patient and careful to resolve these conflicts.
0 commit comments