web/_posts/2019-08-09-getting-started.md

172 lines
6.8 KiB
Markdown
Raw Normal View History

2019-09-30 15:38:58 +03:00
---
2019-11-18 17:36:22 +03:00
title: Getting Started
2020-04-06 21:11:50 +03:00
author: Cotes Chung
2019-09-30 15:38:58 +03:00
date: 2019-08-09 20:55:00 +0800
categories: [Blogging, Tutorial]
2019-11-05 17:14:02 +03:00
tags: [getting started]
2020-06-06 07:45:33 +03:00
pin: true
2019-09-30 15:38:58 +03:00
---
2021-01-25 15:19:50 +03:00
## Prerequisites
2021-07-19 17:24:04 +03:00
Follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll` and `Bundler`. Please note that the version of `Ruby` must meet the requirements of the theme on [RubyGems.org](https://rubygems.org/gems/jekyll-theme-chirpy).
2019-09-30 15:38:58 +03:00
2020-08-02 21:25:40 +03:00
## Installation
2019-09-30 15:38:58 +03:00
2021-01-25 15:19:50 +03:00
There are two ways to get the theme:
2020-08-02 21:25:40 +03:00
2021-07-19 17:24:04 +03:00
- **[Install from RubyGems](#install-from-rubygems)** - Easy to update, isolate irrelevant project files so you can focus on writing.
- **[Fork on GitHub](#fork-on-github)** - Convenient for custom development, but difficult to update, only suitable for web developers.
2021-01-25 15:19:50 +03:00
2021-07-19 17:24:04 +03:00
### Install from RubyGems
2020-08-02 21:25:40 +03:00
2021-01-25 15:19:50 +03:00
Add this line to your Jekyll site's `Gemfile`:
2020-08-02 21:25:40 +03:00
2021-01-25 15:19:50 +03:00
```ruby
gem "jekyll-theme-chirpy"
```
2020-08-02 21:25:40 +03:00
2021-01-25 15:19:50 +03:00
And add this line to your Jekyll site's `_config.yml`:
2020-08-02 21:25:40 +03:00
2021-01-25 15:19:50 +03:00
```yaml
theme: jekyll-theme-chirpy
2020-08-02 21:25:40 +03:00
```
2021-01-25 15:19:50 +03:00
And then execute:
2020-08-02 21:25:40 +03:00
2021-01-25 15:19:50 +03:00
```console
$ bundle
```
2021-07-19 17:24:04 +03:00
Next, go to the installed local theme path:
2021-07-19 17:24:04 +03:00
```console
$ cd "$(bundle info --path jekyll-theme-chirpy)"
```
And then copy the critical files (for details, see [starter project][starter]) from the theme's gem to your Jekyll site.
> ⚠️ **Watch out for duplicate files!**
2021-01-25 15:19:50 +03:00
>
2021-07-19 17:24:04 +03:00
If your Jekyll site is created by the `jekyll new` command, there will be `index.markdown` and `about.markdown` in the root directory of your site. Please be sure to remove them, otherwise they will overwrite the `index.html` and `_tabs/about.html` from this project, resulting in blank or messy pages.
2021-07-19 17:24:04 +03:00
As an alternative, which we recommend, you can create a Jekyll site [**using the starter template**][use-starter] to save time copying files from the theme's gem. We've prepared everything you need there!
2021-01-25 15:19:50 +03:00
### Fork on GitHub
2021-01-25 15:19:50 +03:00
2021-02-10 11:58:53 +03:00
[Fork **Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/fork) on GitHub and then clone your fork to local. (Please note that the default branch code is in development. If you want the blog to be stable, please switch to the [latest tag](https://github.com/cotes2020/jekyll-theme-chirpy/tags) and start writing.)
2020-04-12 19:38:56 +03:00
2021-01-25 15:19:50 +03:00
Install gem dependencies by:
```console
$ bundle
```
2020-04-12 19:38:56 +03:00
2021-01-25 15:19:50 +03:00
And then execute:
2019-10-11 19:46:12 +03:00
2020-08-02 21:25:40 +03:00
```console
$ bash tools/init.sh
2019-10-11 19:46:12 +03:00
```
2021-01-25 15:19:50 +03:00
> **Note**: If you don't plan to deploy your site on GitHub Pages, append parameter option `--no-gh` at the end of the above command.
2019-11-05 17:14:02 +03:00
2020-08-02 21:25:40 +03:00
What it does is:
2019-11-05 17:14:02 +03:00
1. Remove some files or directories from your repository:
- `.travis.yml`
- files under `_posts`
- folder `docs`
2021-04-19 16:01:36 +03:00
2. If you use the `--no-gh` option, the directory `.github` will be deleted. Otherwise, setup the GitHub Action workflow by removing the extension `.hook` of `.github/workflows/pages-deploy.yml.hook`, and then remove the other files and directories in the folder `.github`.
2021-01-25 15:19:50 +03:00
3. Automatically create a commit to save the changes.
2021-01-25 15:19:50 +03:00
## Usage
2019-09-30 15:38:58 +03:00
2020-08-02 21:25:40 +03:00
### Configuration
2019-09-30 15:38:58 +03:00
2021-01-25 15:19:50 +03:00
Update the variables of `_config.yml` as needed. Some of them are typical options:
- `url`
- `avatar`
- `timezone`
2021-02-01 23:23:53 +03:00
- `lang`
2020-03-04 15:07:02 +03:00
2021-07-19 17:24:04 +03:00
### Customing Stylesheet
If you need to customize stylesheet, copy the theme's `assets/css/style.scss` to the same path on your Jekyll site, and then add the custom style at the end of the style file.
Starting from `v4.1.0`, if you want to overwrite the SASS variables defined in `_sass/addon/variables.scss`, create a new file `_sass/variables-hook.scss` and assign new values to the target variable in it.
2021-01-25 15:19:50 +03:00
### Running Local Server
2019-09-30 15:38:58 +03:00
2020-08-02 21:25:40 +03:00
You may want to preview the site contents before publishing, so just run it by:
2019-09-30 15:38:58 +03:00
2021-01-25 15:19:50 +03:00
```console
2020-11-19 16:32:50 +03:00
$ bundle exec jekyll s
2019-09-30 15:38:58 +03:00
```
2021-01-25 15:19:50 +03:00
Or run the site on Docker with the following command:
```terminal
2021-01-25 15:19:50 +03:00
$ docker run -it --rm \
--volume="$PWD:/srv/jekyll" \
-p 4000:4000 jekyll/jekyll \
2020-11-19 16:32:50 +03:00
jekyll serve
```
2021-01-25 15:19:50 +03:00
Open a browser and visit to _<http://localhost:4000>_.
2020-08-02 21:25:40 +03:00
### Deployment
2021-04-19 16:01:36 +03:00
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`.
2020-08-02 21:25:40 +03:00
2021-01-26 21:56:38 +03:00
Now you can choose ONE of the following methods to deploy your Jekyll site.
2019-09-30 15:38:58 +03:00
2020-08-02 21:25:40 +03:00
#### Deploy on GitHub Pages
2020-01-04 12:05:41 +03:00
2021-01-25 15:19:50 +03:00
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.
2021-01-26 21:56:38 +03:00
Quickly check the files needed for GitHub Actions build:
2021-02-01 23:23:53 +03:00
- 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.
2021-03-12 10:20:00 +03:00
- Ensure your Jekyll site has file `tools/test.sh` and `tools/deploy.sh`. Otherwise, copy them from this repo to your Jekyll site.
2021-01-25 15:19:50 +03:00
2021-04-19 16:01:36 +03:00
And then rename your repository to `<GH-USERNAME>.github.io` on GitHub.
2021-01-25 15:19:50 +03:00
2021-02-01 23:23:53 +03:00
Now publish your Jekyll site by:
2021-01-25 15:19:50 +03:00
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.
2019-09-30 15:38:58 +03:00
2021-04-19 16:01:36 +03:00
2. Browse to your repo's landing page on GitHub and select the branch `gh-pages` as the [publishing source](https://docs.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) through _Settings__Options__GitHub Pages_:
2019-10-11 19:46:12 +03:00
![gh-pages-sources](https://cdn.jsdelivr.net/gh/cotes2020/chirpy-images/posts/20190809/gh-pages-sources.png){: width="850" height="153" }
2019-09-30 15:38:58 +03:00
3. Visit your website at the address indicated by GitHub.
#### Deploy on Other Platforms
2019-09-30 15:38:58 +03:00
On platforms other than GitHub, we cannot enjoy the convenience of **GitHub Actions**. Therefore, we should build the site locally (or on some other 3rd-party CI platform) and then put the site files on the server.
2019-09-30 15:38:58 +03:00
Go to the root of the source project, build your site by:
2019-09-30 15:38:58 +03:00
```console
2020-11-19 16:32:50 +03:00
$ JEKYLL_ENV=production bundle exec jekyll b
```
2021-01-25 15:19:50 +03:00
Or build the site with Docker by:
```terminal
2020-11-19 16:32:50 +03:00
$ docker run -it --rm \
--env JEKYLL_ENV=production \
--volume="$PWD:/srv/jekyll" \
jekyll/jekyll \
2020-11-19 16:32:50 +03:00
jekyll build
2019-09-30 15:38:58 +03:00
```
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.
[starter]: https://github.com/cotes2020/chirpy-starter
[use-starter]: https://github.com/cotes2020/chirpy-starter/generate
[workflow]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/workflows/pages-deploy.yml.hook