diff --git a/README.md b/README.md index e1a284b..3fc76d0 100644 --- a/README.md +++ b/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://.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://.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. diff --git a/_posts/2019-08-09-getting-started.md b/_posts/2019-08-09-getting-started.md index 56fd327..803c22b 100644 --- a/_posts/2019-08-09-getting-started.md +++ b/_posts/2019-08-09-getting-started.md @@ -100,7 +100,7 @@ Few days later, you may find that the file changes does not refresh in real time ## Deploying to GitHub Pages -Before the deployment begins, ensure the `url` in file `_config.yml` has been set to `https://.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://.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 @@ -155,8 +155,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. diff --git a/docs/README_zh-CN.md b/docs/README_zh-CN.md index 6d3ab38..21e750e 100644 --- a/docs/README_zh-CN.md +++ b/docs/README_zh-CN.md @@ -30,14 +30,14 @@ Language: [English](../README.md) | 简体中文 ## 目录 -* [开始](#开始) +* [安装](#安装) * [运行指南](#运行指南) * [参与贡献](#参与贡献) * [感谢](#感谢) * [赞助](#赞助) * [许可证书](#许可证书) -## 开始 +## 安装 ### 准备工作 @@ -146,7 +146,7 @@ $ bash tools/run.sh ### 部署到 GitHub Pages -部署开始前,把 `_config.yml` 的 `url` 改为 `https://.github.io`(或者你的私有域名,如:`https://yourdomain.com`). +部署开始前,把 `_config.yml` 的 `url` 改为 `https://.github.io`(或者你的私有域名,如:`https://yourdomain.com`)。另外,如果你想使用 [Project 类型网站](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites),修改配置文件的 `baseurl` 为项目名称,以斜杠开头,如:`/project`。 #### 方法 1: 由 GitHub Pages 生成站点 @@ -201,8 +201,6 @@ $ bash tools/build.sh -d /path/to/local/project/ ``` > `project` 为新仓库名称。 -如果你想使用 Project 网站,修改配置文件的 `baseurl` 为项目名称,以斜杠开头,如:`/project`。或者,在上述命令行后面加参数`-b /project`,`project` 替换为新仓库名称。 - 生成的静态文件将会在 `/path/to/local/project`. 把新仓库的修改提交并推送到远端 `master` 分支. **3**. 回到 GithHub 网页,为该仓库开启 Pages 服务。