f.weber/jekyll-theme-chirpy
Template
1
0
Fork 0
mirror of https://github.com/cotes2020/jekyll-theme-chirpy.git synced 2025-12-18 05:41:31 +00:00
Code Issues Packages Releases Activity

Update Docs.

Browse Source
This commit is contained in:
Cotes Chung
2020-07-09 04:52:03 +08:00
parent 46c2cfe64e
commit 313c44f238
5 changed files with 38 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -47,15 +47,15 @@ To improve the writing experience, we need to use some script tools. If your mac
* Debian
```console
$ sudo apt-get install coreutils
```
```console
$ sudo apt-get install coreutils
```
* macOS
```console
$ brew install coreutils
```
```console
$ brew install coreutils
```
### Jekyll Plugins
@@ -66,7 +66,7 @@ $ brew install coreutils
$ git clone git@github.com:USER/jekyll-theme-chirpy.git -b master
```
and replace the `USER` above to your GitHub username.
And replace the `USER` above to your GitHub username.
The first time you run or build the project on local machine, perform the installation of Jekyll plugins. Go to the root of repo and run:
@@ -82,7 +82,7 @@ $ bundle install
### Directory Structure
The main files and related brief introductions are listed below.
The main files and related brief introductions are listed below:
```sh
jekyll-theme-chirpy/
@@ -113,8 +113,9 @@ jekyll-theme-chirpy/
As mentioned above, some files or directories should be removed from your repo:
- .travis.yml
- .github
```terminal
$ rm -rf .travis.yml .github _posts/*
```
### Configuration
@@ -164,7 +165,7 @@ Before the deployment begins, checkout the file `_config.yml` and make sure that
By deploying the site in this way, you're allowed to push the source code directly to the remote.
> **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).
> **Note**: If you want to use any third-party Jekyll plugins that not on [this list](https://pages.github.com/versions/), stop reading the current approach and go to [*Option 2: Build locally*](#option-2-build-locally).
**1**. Rename the repository to:
@@ -202,7 +203,7 @@ it will automatically generates the *Latest Modified Date* and *Categories / Tag
#### Option 2: Build Locally
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**.
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 other plugin that not on 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: