mirror of
https://github.com/cotes2020/jekyll-theme-chirpy.git
synced 2025-12-18 05:41:31 +00:00
Fixed tutorial.
This commit is contained in:
10
README.md
10
README.md
@@ -30,7 +30,7 @@ You will get the following features:
|
||||
|
||||
## Table of Contents
|
||||
|
||||
* [Getting Started](#getting-started)
|
||||
* [Installing](#installing)
|
||||
* [Usage](#usage)
|
||||
* [Contributing](#contributing)
|
||||
* [Credits](#credits)
|
||||
@@ -38,7 +38,7 @@ You will get the following features:
|
||||
* [License](#license)
|
||||
|
||||
|
||||
## Getting Started
|
||||
## Installing
|
||||
|
||||
### Prerequisites
|
||||
|
||||
@@ -59,7 +59,7 @@ $ brew install coreutils
|
||||
```
|
||||
|
||||
|
||||
### Installing
|
||||
### Jekyll Plugins
|
||||
|
||||
[Fork **Chirpy** from GitHub](https://github.com/cotes2020/jekyll-theme-chirpy/fork), then clone your forked repo to local:
|
||||
|
||||
@@ -147,7 +147,7 @@ Few days later, you may find that the file modification(e.g. edits to a post) do
|
||||
|
||||
### Deploying to GitHub Pages
|
||||
|
||||
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`).
|
||||
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`.
|
||||
|
||||
#### Option 1: Built by GitHub Pages
|
||||
|
||||
@@ -201,8 +201,6 @@ and clone it.
|
||||
$ bash tools/build.sh -d /path/to/local/project/
|
||||
```
|
||||
|
||||
If you prefer to the Project site, change `baseurl` of file `_config.yml` to your project name, starting with a slash. e.g. `/project`. Or, simply add argument `-b /project` behide the command above.
|
||||
|
||||
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.
|
||||
|
||||
Reference in New Issue
Block a user