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
Clone the repository locally, but to prevent losing the latest features, consider using **Fork** instead of cloning.
36
-
37
-
Install the Jekyll plugins:
36
+
Next, [**fork**](https://github.com/cotes2020/jekyll-theme-chirpy/fork) this project and rename as `<username>.github.io`, then clone the replicated repository locally. Go to the root directory and install the Jekyll plugins:
38
37
39
38
```
40
39
$ bundle install
@@ -48,7 +47,9 @@ $ bash run.sh
48
47
49
48
Now, open your favorite brower and visit <http://127.0.0.1:4000>
50
49
51
-
Please refer to the [documentation](https://chirpy.cotes.info/posts/getting-started/) for more details. Hope you like it.
50
+
## Documentation
51
+
52
+
For more details, please check the [tutorial](https://chirpy.cotes.info/posts/getting-started/). BTW, a copy of the tutorial is also available on the [Wiki](https://github.com/cotes2020/jekyll-theme-chirpy/wiki).
Copy file name to clipboardExpand all lines: _posts/2019-08-09-getting-started.md
+47-15Lines changed: 47 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,20 +2,19 @@
2
2
title: Getting Started
3
3
date: 2019-08-09 20:55:00 +0800
4
4
categories: [Blogging, Tutorial]
5
-
tags: [usage]
5
+
tags: [getting started]
6
6
---
7
7
8
+
## Preparation
8
9
9
-
## Basic Environment
10
+
First of all, follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installtion of basic environment (Ruby, RubyGem, Bundler and Jekyll). In addition, to use the funny script tools, we also need to install [Python](https://www.python.org/downloads/)(version 3.5 or abover), [ruamel.yaml](https://pypi.org/project/ruamel.yaml/) and [fswatch](http://emcrisostomo.github.io/fswatch/getting.html).
10
11
11
-
First of all, follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the basic environment (Ruby, RubyGem, Bundler and Jekyll) installation.
12
+
Next, [fork Chirpy](https://github.com/cotes2020/jekyll-theme-chirpy/fork) and then clone the replicated repository locally.
12
13
13
-
In addition, the [Python](https://www.python.org/downloads/)(version 3.5 or abover) and [ruamel.yaml](https://pypi.org/project/ruamel.yaml/) are also required.
14
14
15
+
## Install Jekyll plugins
15
16
16
-
## Install Jekyll Plugins
17
-
18
-
In the root direcoty of the project, run the following command:
17
+
Go to root directory of the repository and run the following:
19
18
20
19
```terminal
21
20
$ bundle install
@@ -24,6 +23,39 @@ $ bundle install
24
23
`bundle` will install all the dependent Jekyll Plugins listed in file `Gemfile` automatically.
25
24
26
25
26
+
## File structure
27
+
28
+
The main files and related brief introductions are listed below.
29
+
30
+
```sh
31
+
jekyll-theme-chirpy/
32
+
├── _data
33
+
├── _includes
34
+
├── _layouts
35
+
├── _posts # posts stay here
36
+
├── _scripts
37
+
├── assets
38
+
├── tabs
39
+
│ └── about.md # the ABOUT page
40
+
├── .gitignore
41
+
├── .travis.yml # remove it
42
+
├── 404.html
43
+
├── Gemfile
44
+
├── LICENSE
45
+
├── README.md
46
+
├── _config.yml # configuration file
47
+
├── build.sh # script tool
48
+
├── run.sh # script tool
49
+
├── init.sh # script tool
50
+
├── pv.sh
51
+
├── feed.xml
52
+
├── index.html
53
+
├── robots.txt
54
+
├── search.json
55
+
└── sitemap.xml
56
+
```
57
+
58
+
27
59
## Configuration
28
60
29
61
Customize the variables in file `_config.yml` as needed.
@@ -34,26 +66,26 @@ Customize the variables in file `_config.yml` as needed.
34
66
The Atom feed url of your site will be:
35
67
36
68
```
37
-
<site_url>/feed.xml
69
+
<SITE_URL>/feed.xml
38
70
```
39
71
40
-
The `site_url` was defined by variable `url` in file `_config.yml`.
72
+
The `SITE_URL` was defined by variable `url` in file `_config.yml`.
41
73
42
74
43
-
## Run Locally
75
+
## Run locally
44
76
45
-
You may want to preview the site before publishing, so just run the script in the root directory:
77
+
You may want to preview the site before publishing, so just run the script tool:
46
78
47
79
```terminal
48
80
$ bash run.sh
49
81
```
50
-
>**Note**: Because the *Recent Update* required the latest git-log date of posts, make sure the changes of `_posts` have been committed before running this command.
82
+
>**Note**: Because the *Recent Update* required the latest git-log date of posts, so make sure the changes of `_posts` have been committed before running this command.
51
83
52
-
Open the brower and visit [http://127.0.0.1:4000](http://127.0.0.1:4000)
84
+
Open a brower and visit <http://127.0.0.1:4000>
53
85
54
86
## Deploying to GitHub Pages
55
87
56
-
Before the deployment begins, ensure the `url` in `_config.yml` has been set to `https://<username>.github.io`.
88
+
Before the deployment begins, rename your project as `<username>.github.io` and ensure the `url` in `_config.yml` has been set to `https://<username>.github.io`.
57
89
58
90
### Option 1: Built by GitHub Pages
59
91
@@ -76,7 +108,7 @@ It will automatically generates the *Latest Modified Date* and *Categories / Tag
76
108
**4**. Visit `https://<username>.github.io` and enjoy.
77
109
78
110
79
-
### Option 2: Build Locally
111
+
### Option 2: Build locally
80
112
81
113
For security reasons, GitHub Pages runs on `safe` mode, which means the third-party Jekyll plugins or custom scripts will not work. If you want to use any another third-party Jekyll plugins, **your have to build locally rather than on GitHub Pages**.
0 commit comments