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

143 lines
5.4 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
---
2020-08-02 21:25:40 +03:00
## Installation
2019-09-30 15:38:58 +03:00
2020-08-02 21:25:40 +03:00
[Fork **Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/fork) on GitHub, and clone the fork to local by:
```terminal
$ git clone git@github.com:<username>/jekyll-theme-chirpy -b master --single-branch
```
### Setting up the local envrionment
If you would like to run or build the project on your local machine, please follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems` and `Bundler`.
Before running or building for the first time, please complete the installation of the Jekyll plugins. Go to the root directory of project and run:
```terminal
$ bundle install
```
`bundle` will automatically install all the dependencies specified by `Gemfile`.
What's more, in order to generate some extra files (*categories*, *tags* and *last modified list*), we need to use some tool scripts. If your machine is running Debian or macOS, make sure that [GNU coreutils](https://www.gnu.org/software/coreutils/) is installed. Otherwise, install by:
* Debian
2020-07-08 23:52:03 +03:00
```console
$ sudo apt-get install coreutils
```
* macOS
2020-07-08 23:52:03 +03:00
```console
$ brew install coreutils
```
2019-09-30 15:38:58 +03:00
2019-10-11 19:46:12 +03:00
2020-08-02 21:25:40 +03:00
## Usage
2020-04-12 19:38:56 +03:00
2020-08-02 21:25:40 +03:00
Running [**Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/) requires some extra files, which cannot be generated by Jekyll native commands, so please strictly follow the methods mentioned below to run or deploy your website.
2020-04-12 19:38:56 +03:00
2020-08-02 21:25:40 +03:00
### Initialization
2020-04-12 19:38:56 +03:00
2020-08-02 21:25:40 +03:00
Go to the root directory of the project and start initialization:
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
```
2020-08-02 21:25:40 +03:00
> If you not intend to deploy it 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
2020-08-02 21:25:40 +03:00
1. Remove some files or directories from your repository:
- `.travis.yml`
- everything under `.github/`
- files under `_posts/`
- folder `docs/`
2020-01-04 12:05:41 +03:00
2020-08-02 21:25:40 +03:00
2. Unless the option `--no-gh` was enabled, setup the GitHub action workflow by renaming `pages-deploy.yml.hook` of directory `.github/workflows/` to `pages-deploy.yml`.
2020-01-04 12:05:41 +03:00
2020-08-02 21:25:40 +03:00
3. Automatically create a commit to save the changes.
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
2020-08-02 21:25:40 +03:00
Generally, go to `_config.yml` and configure the variables as needed. Some of them are typical options:
2020-03-04 15:07:02 +03:00
* `url`
* `avatar`
* `timezone`
* `theme_mode`
2020-08-02 21:25:40 +03:00
### Run Locally
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
```terminal
2020-01-01 20:21:43 +03:00
$ bash tools/run.sh
2019-09-30 15:38:58 +03:00
```
2020-08-02 21:25:40 +03:00
Then open a browser and visit to <http://localhost:4000>.
2019-11-18 17:36:22 +03:00
Few days later, you may find that the file changes does not refresh in real time by using `run.sh`. Don't worry, the advanced option `-r` (or `--realtime`) will solve this problem, but it requires [**fswatch**](http://emcrisostomo.github.io/fswatch/) to be installed on your machine.
2019-09-30 15:38:58 +03:00
2020-08-02 21:25:40 +03:00
### Deployment
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. For example, `/project`.
Assuming you have already gone through the [initialization](#initialization), you can now choose any of the following methods to deploy your website.
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
2020-08-02 21:25:40 +03:00
For security reasons, GitHub Pages build runs on `safe` mode, which restricts us from using tool scripts 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 Pages service.
2019-09-30 15:38:58 +03:00
2020-08-02 21:25:40 +03:00
1. Push any commit to `origin/master` to trigger the GitHub Actions workflow. Once the build is complete, a new remote branch called `gh-pages` will appear, which is used to store the built site files.
2019-09-30 15:38:58 +03:00
2020-08-02 21:25:40 +03:00
2. Unless you prefer to project sites, rename your repository to `<username>.github.io` on GitHub.
2019-09-30 15:38:58 +03:00
2020-08-02 21:25:40 +03:00
3. Choose branch `gh-pages` as your GitHub Pages source.
2019-10-11 19:46:12 +03:00
2020-08-02 21:25:40 +03:00
4. Visit your website at the address indicated by GitHub.
2019-10-11 19:46:12 +03:00
2020-08-02 21:25:40 +03:00
#### Deploy on Other Platforms
2020-01-04 12:05:41 +03:00
2020-08-02 21:25:40 +03:00
On platforms other than GitHub, e.g. GitLab, we cannot enjoy the convenience of **GitHub Actions**. However, we have a tool to make up for this shortcoming.
Commit the changes of your repository first, then run the publish script:
2019-09-30 15:38:58 +03:00
```console
$ bash tools/publish.sh
2019-09-30 15:38:58 +03:00
```
> Please note that the *Recent Update* list requires the latest git-log date of posts, thus make sure the changes in `_posts` have been committed before running this command.
2020-08-02 21:25:40 +03:00
It will automatically generates the *Latest Modified Date* and *Categories / Tags* page for the posts and submit a commit, then push to `origin/master`. Its output is similar to the following log:
2020-03-04 15:07:02 +03:00
```terminal
[INFO] Success to update lastmod for 4 post(s).
[INFO] Succeed! 3 category-pages created.
[INFO] Succeed! 4 tag-pages created.
[INFO] Published successfully!
2020-03-04 15:07:02 +03:00
```
2020-08-02 21:25:40 +03:00
Lastly, enable the pages service according to the instructions of the platform you choose.
2019-09-30 15:38:58 +03:00
2020-08-02 21:25:40 +03:00
#### Deploy on Private Server
2019-09-30 15:38:58 +03:00
2020-08-02 21:25:40 +03:00
In the root of the source project, build your site by:
2019-09-30 15:38:58 +03:00
```console
2020-08-02 21:25:40 +03:00
$ bash tools/build.sh -d /path/to/site/
2019-09-30 15:38:58 +03:00
```
2020-08-02 21:25:40 +03:00
The generated site files will be placed in the root of `/path/to/site/`. Now you should upload those files to your web server, such as Nginx.