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

183 lines
7.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
2021-12-04 21:29:40 +03:00
author:
name: Cotes Chung
link: https://github.com/cotes2020
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
Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll`, and `Bundler`.
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-09-29 15:44:00 +03:00
### Creating a New Site
2020-08-02 21:25:40 +03:00
2021-09-29 15:44:00 +03:00
There are two ways to create a new repository for this theme:
2021-01-25 15:19:50 +03:00
- [**Using the Chirpy Starter**](#option-1-using-the-chirpy-starter) - Easy to upgrade, isolates irrelevant project files so you can focus on writing.
- [**Forking on GitHub**](#option-2-forking-on-github) - Convenient for custom development, but difficult to upgrade. Unless you are familiar with Jekyll and are determined to tweak or contribute to this project, this approach is not recommended.
2020-08-02 21:25:40 +03:00
2021-09-29 15:44:00 +03:00
#### Option 1. Using the Chirpy Starter
2020-08-02 21:25:40 +03:00
2021-09-29 15:44:00 +03:00
Create a new repository from the [**Chirpy Starter**][use-starter] and name it `<GH_USERNAME>.github.io`, where `GH_USERNAME` represents your GitHub username.
2020-08-02 21:25:40 +03:00
2021-09-29 15:44:00 +03:00
#### Option 2. Forking on GitHub
[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.
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
2021-09-29 15:44:00 +03:00
$ bash tools/init.sh
2021-01-25 15:19:50 +03:00
```
2021-09-29 15:44:00 +03:00
> **Note**: If you don't want to deploy your site on GitHub Pages, append option `--no-gh` at the end of the above command.
2021-09-29 15:44:00 +03:00
The above command will:
2021-07-19 17:24:04 +03:00
2021-09-29 15:44:00 +03:00
1. Removes some files or directories from your repository:
- `.travis.yml`
- files under `_posts`
- folder `docs`
2021-07-19 17:24:04 +03:00
2. If the option `--no-gh` is provided, the directory `.github` will be deleted. Otherwise, set up 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-09-29 15:44:00 +03:00
3. Removes item `Gemfile.lock` from `.gitignore`.
2021-01-25 15:19:50 +03:00
2021-09-29 15:44:00 +03:00
4. Creates a new commit to save the changes automatically.
2021-01-25 15:19:50 +03:00
2021-09-29 15:44:00 +03:00
### Installing Dependencies
2020-04-12 19:38:56 +03:00
Before running for the first time, go to the root directory of your site, and install dependencies as follows:
2021-01-25 15:19:50 +03:00
```console
$ bundle
```
2020-04-12 19:38:56 +03:00
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 the 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.
2021-07-19 17:24:04 +03:00
2021-09-29 15:44:00 +03:00
Starting from [`v4.1.0`][chirpy-4.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-07-19 17:24:04 +03:00
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:
2021-09-29 15:44:00 +03:00
```console
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-09-29 15:44:00 +03:00
After a while, the local service will be published at _<http://127.0.0.1:4000>_.
2020-08-02 21:25:40 +03:00
### Deployment
Before the deployment begins, check out 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 starts 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
2021-09-29 15:44:00 +03:00
#### Deploy by Using Github Actions
2020-01-04 12:05:41 +03:00
2021-09-29 15:44:00 +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 GitHub Pages service.
2021-01-25 15:19:50 +03:00
2021-01-26 21:56:38 +03:00
Quickly check the files needed for GitHub Actions build:
2021-09-29 15:44:00 +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 [sample file][workflow], and the value of the `on.push.branches` should be the same as your repo's default branch name.
- Ensure your Jekyll site has file `tools/deploy.sh`. Otherwise, copy it from here to your Jekyll site.
- Furthermore, if you have committed `Gemfile.lock` to the repo, and your runtime system is not Linux, don't forget to update the platform list in the lock file:
2021-09-29 15:44:00 +03:00
```console
$ bundle lock --add-platform x86_64-linux
```
2021-01-25 15:19:50 +03:00
2021-09-29 15:44:00 +03:00
After the above steps, 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-09-29 15:44:00 +03:00
2. Browse to your repository on GitHub. Select the tab _Settings_, then click _Pages_ in the left navigation bar, and then in the section **Source** of _GitHub Pages_, select the `/(root)` directory of branch `gh-pages` as the [publishing source][pages-src]. Remember to click <kbd>Save</kbd> before leaving.
2021-11-26 18:29:51 +03:00
2022-01-02 18:56:29 +03:00
![gh-pages-sources](/posts/20190809/gh-pages-sources.png){: width="1580" height="250" }
2019-09-30 15:38:58 +03:00
3. Visit your website at the address indicated by GitHub.
2021-09-29 15:44:00 +03:00
#### Manually Build and Deploy
2019-09-30 15:38:58 +03:00
2021-09-29 15:44:00 +03:00
On self-hosted servers, you cannot enjoy the convenience of **GitHub Actions**. Therefore, you should build the site on your local machine and then upload the site files to the server.
2019-09-30 15:38:58 +03:00
2021-09-29 15:44:00 +03:00
Go to the root of the source project, and build your site as follows:
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-09-29 15:44:00 +03:00
Or build the site on Docker:
2021-09-29 15:44:00 +03:00
```console
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
```
2021-09-29 15:44:00 +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 the target server.
### Upgrading
It depends on how you use the theme:
- If you are using the theme gem (there will be `gem "jekyll-theme-chirpy"` in the `Gemfile`), editing the `Gemfile` and update the version number of the theme gem, for example:
2021-09-29 15:44:00 +03:00
2021-10-25 20:16:50 +03:00
```diff
2021-09-29 15:44:00 +03:00
- gem "jekyll-theme-chirpy", "~> 3.2", ">= 3.2.1"
+ gem "jekyll-theme-chirpy", "~> 3.3", ">= 3.3.0"
2021-10-25 20:16:50 +03:00
```
{: .nolineno file="Gemfile" }
2021-09-29 15:44:00 +03:00
2021-10-25 20:16:50 +03:00
And then execute the following command:
2021-09-29 15:44:00 +03:00
2021-10-25 20:16:50 +03:00
```console
$ bundle update jekyll-theme-chirpy
2021-10-25 20:16:50 +03:00
```
2021-09-29 15:44:00 +03:00
2021-10-25 20:16:50 +03:00
As the version upgrades, the critical files (for details, see the [Startup Template][starter]) and configuration options will change. Please refer to the [Upgrade Guide](https://github.com/cotes2020/jekyll-theme-chirpy/wiki/Upgrade-Guide) to keep your repo's files in sync with the latest version of the theme.
2021-09-29 15:44:00 +03:00
- If you forked from the source project (there will be `gemspec` in the `Gemfile` of your site), then merge the [latest upstream tags][latest-tag] into your Jekyll site to complete the upgrade.
The merge is likely to conflict with your local modifications. Please be patient and careful to resolve these conflicts.
[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
2021-09-29 15:44:00 +03:00
[chirpy-4.1.0]: https://github.com/cotes2020/jekyll-theme-chirpy/releases/tag/v4.1.0
[pages-src]: https://docs.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site
[latest-tag]: https://github.com/cotes2020/jekyll-theme-chirpy/tags