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

193 lines
6.6 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
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]
2019-09-30 15:38:58 +03:00
---
2019-11-05 17:14:02 +03:00
## Preparation
2019-09-30 15:38:58 +03:00
Follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installtion of basic environment (Ruby, RubyGem, Bundler and Jekyll). In order to use the script tools to save time, we also need to install [Python](https://www.python.org/downloads/)(version 3.5 or abover) and [ruamel.yaml](https://pypi.org/project/ruamel.yaml/).
2019-09-30 15:38:58 +03:00
In addition, if your machine is running Debian or macOS, make sure you have the [GNU coreutils](https://www.gnu.org/software/coreutils/) installed. Otherwise, get it by:
* Debian
```console
$ sudo apt-get install coreutils
```
* macOS
```console
$ brew install coreutils
```
2019-09-30 15:38:58 +03:00
2019-10-11 19:46:12 +03:00
2019-11-18 17:36:22 +03:00
## Install Jekyll Plugins
2019-10-11 19:46:12 +03:00
2020-01-04 12:05:41 +03:00
Go to the root of repo and run:
2019-10-11 19:46:12 +03:00
```terminal
$ bundle install
```
`bundle` will install all the dependent Jekyll Plugins listed in file `Gemfile` automatically.
2019-09-30 15:38:58 +03:00
2019-11-18 17:36:22 +03:00
## File Structure
2019-11-05 17:14:02 +03:00
The main files and related brief introductions are listed below.
```sh
jekyll-theme-chirpy/
├── _data
├── _includes
├── _layouts
├── _posts # posts stay here
├── _scripts
2020-01-23 11:54:26 +03:00
├── .travis.yml # remove it
├── .github # remove this, too
2019-11-05 17:14:02 +03:00
├── assets
├── tabs
│   └── about.md # the ABOUT page
├── .gitignore
├── 404.html
├── Gemfile
├── LICENSE
├── README.md
├── _config.yml # configuration file
2020-01-01 20:21:43 +03:00
├── tools # script tools
2019-11-05 17:14:02 +03:00
├── feed.xml
├── index.html
├── robots.txt
└── sitemap.xml
```
2020-01-04 12:05:41 +03:00
As mentioned above, some files or directories should be removed from your repo:
- .travis.yml
- .github
2019-09-30 15:38:58 +03:00
## Configuration
2020-03-04 15:07:02 +03:00
Basically, go to `_config.yml` and customize the variables as needed, some of them are typical options:
2019-09-30 15:38:58 +03:00
2020-03-04 15:07:02 +03:00
* `url`
2020-01-04 12:05:41 +03:00
2020-03-04 15:07:02 +03:00
Set to your website domain and there should be no slash symbol at the tail.
2019-10-11 19:46:12 +03:00
2020-03-04 15:07:02 +03:00
* `avatar`
It defines the image file location of avatar. The sample image is `/assets/img/sample/avatar.jpg`, and should be replaced by your own one(a square image). Notice that a huge image file will increase the load time of your site, so keep your avatar image size as samll as possible(may be *<https://tinypng.com/>* will help).
* `timezone`
2019-09-30 15:38:58 +03:00
2020-01-04 12:05:41 +03:00
To ensure that the posts' release date matches the city you live in, please modify the field `timezone` correctly. A list of all available values can be found on [TimezoneConverter](http://www.timezoneconverter.com/cgi-bin/findzone/findzone) or [Wikipedia](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
2019-09-30 15:38:58 +03:00
2020-03-04 15:07:02 +03:00
* `theme_mode`
There are three options for the theme color scheme:
- **dual** - The default color scheme will follow the system settings, but if the system does not support dark mode, or the browser does not support `Media Queries Level 5`, the theme will be displayed as `light` mode by default. Anyway, the bottom left corner of the Sidebar will provide a button for users to switch color schemes.
- **dark** - Always show dark mode.
- **light** - Always show light mode.
2019-09-30 15:38:58 +03:00
2019-11-18 17:36:22 +03:00
## Run Locally
2019-09-30 15:38:58 +03:00
2019-11-05 17:14:02 +03:00
You may want to preview the site before publishing, so just run the script tool:
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
```
2019-11-18 17:36:22 +03:00
Open a brower and visit <http://localhost:4000>.
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
## Deploying to GitHub Pages
2020-01-14 14:57:10 +03:00
Before the deployment begins, ensure the `url` in file `_config.yml` has been set to `https://<username>.github.io`(or the custom domain, if you have. e.g. `https://yourdomain.com`). What's more, if you prefer to the [Project site](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites), change `baseurl` of file `_config.yml` to your project name, starting with a slash. e.g. `/project`.
2020-01-04 12:05:41 +03:00
2019-09-30 15:38:58 +03:00
2019-10-11 19:46:12 +03:00
### Option 1: Built by GitHub Pages
2019-09-30 15:38:58 +03:00
2020-01-04 12:05:41 +03:00
By deploying the site in this way, you're allowed to push the source code directly to the remote.
2019-09-30 15:38:58 +03:00
2020-01-04 12:05:41 +03:00
> **Note**: If you want to use any third-party Jekyll plugins that not in [this list](https://pages.github.com/versions/), stop reading the current approach and go to [*Option 2: Build locally*](#option-2-build-locally).
2019-10-11 19:46:12 +03:00
2020-01-04 12:05:41 +03:00
**1**. Rename the repository to:
2019-10-11 19:46:12 +03:00
2020-01-04 12:05:41 +03:00
|Site Type | Repo's Name|
|:---|:---|
|User or Organization | `<username>.github.io`|
|Project| any one except `<username>.github.io`, let's say `project`|
**2**. Commit the changes of the repo first, then run the initialization script:
2019-09-30 15:38:58 +03:00
```console
2020-01-01 20:21:43 +03:00
$ bash tools/init.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-03-04 15:07:02 +03:00
it will automatically generates the *Latest Modified Date* and *Categories / Tags* page for the posts and submit a commit. Its output is similar to the following log:
```terminal
[INFO] Success to update lastmod for 4 post(s).
[INFO] Succeed! 3 category-pages created.
[INFO] Succeed! 4 tag-pages created.
[Automation] Updated the Categories, Tags, Lastmod for post(s).
11 files changed, 46 insertions(+), 3 deletions(-)
...
Updated the Categories, Tags, Lastmod for post(s).
```
2020-01-04 12:05:41 +03:00
**3**. Push the changes to `origin/master` then go to GitHub website and enable GitHub Pages service for the repo.
2019-09-30 15:38:58 +03:00
2020-01-04 12:05:41 +03:00
**4**. Check it out:
2019-09-30 15:38:58 +03:00
2020-01-04 12:05:41 +03:00
|Site Type | Site URL |
|:---|:---|
|User or Organization | `https://<username>.github.io/`|
|Project| `https://<username>.github.io/project/`|
2019-09-30 15:38:58 +03:00
2019-11-18 17:36:22 +03:00
### Option 2: Build Locally
2019-09-30 15:38:58 +03:00
2020-01-04 12:05:41 +03:00
For security reasons, GitHub Pages runs on `safe` mode, which means the third-party Jekyll plugins or custom scripts won't work. If you want to use any another plugins that not in the [whitelist](https://pages.github.com/versions/), **you have to generate the site locally rather than on GitHub Pages**.
**1**. Browse to GitHub website, create a brand new repo named:
|Site Type | Repo's Name|
|:---|:---|
|User or Organization | `<username>.github.io`|
|Project| any one except `<username>.github.io`, let's say `project`|
2019-09-30 15:38:58 +03:00
2020-01-04 12:05:41 +03:00
and clone it.
2019-09-30 15:38:58 +03:00
2020-01-04 12:05:41 +03:00
**2**. In the root of the source project, build your site by:
2019-09-30 15:38:58 +03:00
```console
2020-01-04 12:05:41 +03:00
$ bash tools/build.sh -d /path/to/local/project/
2019-09-30 15:38:58 +03:00
```
2020-01-04 12:05:41 +03:00
The generated static files will be placed in the root of `/path/to/local/project`. Commit and push the changes to the `master` branch on GitHub.
**3**. Go to GitHub website and enable Pages service for the new repository.
**4**. Visit at:
2019-09-30 15:38:58 +03:00
2020-01-04 12:05:41 +03:00
|Site Type | Site URL |
|:---|:---|
|User or Organization | `https://<username>.github.io/`|
|Project| `https://<username>.github.io/project/`|
2019-09-30 15:38:58 +03:00
2020-01-04 12:05:41 +03:00
and enjoy!