Update the docs.
This commit is contained in:
parent
c242cf8455
commit
db06610fd6
5 changed files with 16 additions and 24 deletions
10
.github/CONTRIBUTING.md
vendored
10
.github/CONTRIBUTING.md
vendored
|
@ -7,15 +7,9 @@ To ensure that the blog design is not confused, this project does not accept sug
|
||||||
Generally, contribute to the project by:
|
Generally, contribute to the project by:
|
||||||
|
|
||||||
1. Fork this project on GitHub and clone it locally.
|
1. Fork this project on GitHub and clone it locally.
|
||||||
2. Create a new branch named `feature/my-feature` (or `feature/fix-a-bug`), which branch from `develop`:
|
2. Create a new branch from `master` and give it a descriptive name (e.g., `my-new-feature`, `fix-a-bug`).
|
||||||
|
|
||||||
```console
|
|
||||||
$ git checkout -b feature/<my-feature> develop
|
|
||||||
```
|
|
||||||
> Please note that the new branch name must include the prefix `feature/`.
|
|
||||||
|
|
||||||
3. After completing the development, commit and push to remote.
|
3. After completing the development, commit and push to remote.
|
||||||
4. Submit a new **pull request** to the `develop` branch of upstream, i.e., `cotes2020/jekyll-theme-chirpy:develop`.
|
4. Submit a new pull request.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
10
README.md
10
README.md
|
@ -91,11 +91,10 @@ What it does is:
|
||||||
|
|
||||||
1. Remove some files or directories from your repository:
|
1. Remove some files or directories from your repository:
|
||||||
- `.travis.yml`
|
- `.travis.yml`
|
||||||
- everything under `.github/`
|
- files under `_posts`
|
||||||
- files under `_posts/`
|
- folder `docs`
|
||||||
- folder `docs/`
|
|
||||||
|
|
||||||
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`.
|
2. If you use the `--no-gh` option, the directory `.github` will be deleted. Otherwise, setup the GitHub Action workflow by removing extension `.hook` of `.github/workflows/pages-deploy.yml.hook`, and then remove the other files and directories in folder `.github`.
|
||||||
|
|
||||||
3. Automatically create a commit to save the changes.
|
3. Automatically create a commit to save the changes.
|
||||||
|
|
||||||
|
@ -134,7 +133,8 @@ For security reasons, GitHub Pages build runs on `safe` mode, which restricts us
|
||||||
|
|
||||||
2. Unless you prefer to project sites, rename your repository to `<username>.github.io` on GitHub.
|
2. Unless you prefer to project sites, rename your repository to `<username>.github.io` on GitHub.
|
||||||
|
|
||||||
3. Choose branch `gh-pages` as your GitHub Pages source.
|
3. Choose branch `gh-pages` as the [publishing source](https://docs.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) for your GitHub Pages site.
|
||||||
|
|
||||||
|
|
||||||
4. Visit your website at the address indicated by GitHub.
|
4. Visit your website at the address indicated by GitHub.
|
||||||
|
|
||||||
|
|
|
@ -8,7 +8,7 @@ tags: [writing]
|
||||||
|
|
||||||
## Naming and Path
|
## Naming and Path
|
||||||
|
|
||||||
Create a new file named `YYYY-MM-DD-TITLE.EXTENSION` and put it in the `_post/` of the root directory. The `EXTENSION` must be one of `md` and `markdown`. From `v2.4.1`, you can create sub-directories under `_posts/` to categorize posts.
|
Create a new file named `YYYY-MM-DD-TITLE.EXTENSION` and put it in the `_post/` of the root directory. Please note that the `EXTENSION` must be one of `md` and `markdown`. From `v2.4.1`, you can create sub-directories under `_posts/` to categorize posts.
|
||||||
|
|
||||||
## Front Matter
|
## Front Matter
|
||||||
|
|
||||||
|
@ -146,7 +146,7 @@ This is a common code snippet, without syntax highlight and line number.
|
||||||
|
|
||||||
## Specific Language
|
## Specific Language
|
||||||
|
|
||||||
Using <code class="highlighter-rouge">```Language</code> you will get code snippets with line Numbers and syntax highlight.
|
Using <code class="highlighter-rouge">```language</code> you will get code snippets with line Numbers and syntax highlight.
|
||||||
|
|
||||||
> **Note**: The Jekyll style `{% raw %}{%{% endraw %} highlight LANGUAGE {% raw %}%}{% endraw %}` or `{% raw %}{%{% endraw %} highlight LANGUAGE linenos {% raw %}%}{% endraw %}` are not allowed to be used in this theme !
|
> **Note**: The Jekyll style `{% raw %}{%{% endraw %} highlight LANGUAGE {% raw %}%}{% endraw %}` or `{% raw %}{%{% endraw %} highlight LANGUAGE linenos {% raw %}%}{% endraw %}` are not allowed to be used in this theme !
|
||||||
|
|
||||||
|
|
|
@ -61,11 +61,10 @@ What it does is:
|
||||||
|
|
||||||
1. Remove some files or directories from your repository:
|
1. Remove some files or directories from your repository:
|
||||||
- `.travis.yml`
|
- `.travis.yml`
|
||||||
- everything under `.github/`
|
- files under `_posts`
|
||||||
- files under `_posts/`
|
- folder `docs`
|
||||||
- folder `docs/`
|
|
||||||
|
|
||||||
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`.
|
2. If you use the `--no-gh` option, the directory `.github` will be deleted. Otherwise, setup the GitHub Action workflow by removing extension `.hook` of `.github/workflows/pages-deploy.yml.hook`, and then remove the other files and directories in folder `.github`.
|
||||||
|
|
||||||
3. Automatically create a commit to save the changes.
|
3. Automatically create a commit to save the changes.
|
||||||
|
|
||||||
|
@ -104,7 +103,7 @@ For security reasons, GitHub Pages build runs on `safe` mode, which restricts us
|
||||||
|
|
||||||
2. Unless you prefer to project sites, rename your repository to `<username>.github.io` on GitHub.
|
2. Unless you prefer to project sites, rename your repository to `<username>.github.io` on GitHub.
|
||||||
|
|
||||||
3. Choose branch `gh-pages` as your GitHub Pages source.
|
3. Choose branch `gh-pages` as the [publishing source](https://docs.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) for your GitHub Pages site.
|
||||||
|
|
||||||
4. Visit your website at the address indicated by GitHub.
|
4. Visit your website at the address indicated by GitHub.
|
||||||
|
|
||||||
|
|
|
@ -95,13 +95,12 @@ $ bash tools/init.sh
|
||||||
|
|
||||||
1. 从你的仓库中删除了:
|
1. 从你的仓库中删除了:
|
||||||
- `.travis.yml`
|
- `.travis.yml`
|
||||||
- `.github` 下的文件和目录
|
|
||||||
- `_posts` 下的文件
|
- `_posts` 下的文件
|
||||||
- `docs` 目录
|
- `docs` 目录
|
||||||
|
|
||||||
2. 配置了 GitHub Actions:把 `.github/workflows/` 的文件 `pages-deploy.yml.hook` 重命名为 `pages-deploy.yml`。
|
2. 如果使用了参数 `--no-gh`,则会怒删 `.github`。否则,将会配置 GitHub Actions:把 `.github/workflows/pages-deploy.yml.hook` 的后缀 `.hook` 去除,然后删除 `.github` 里的其他目录和文件。
|
||||||
|
|
||||||
3. 自动提交一个 Commit 以保存文件的更改。
|
3. 自动提交一个 Commit 以保存上述文件的更改。
|
||||||
|
|
||||||
### 配置文件
|
### 配置文件
|
||||||
|
|
||||||
|
@ -139,7 +138,7 @@ $ bash tools/run.sh
|
||||||
|
|
||||||
2. 除非你是使用 project 站点, 否则重命名你的仓库为 `<username>.github.io`。
|
2. 除非你是使用 project 站点, 否则重命名你的仓库为 `<username>.github.io`。
|
||||||
|
|
||||||
3. 选择分支 `gh-pages` 作为 GitHub Pages 的源.
|
3. 选择分支 `gh-pages` 作为 GitHub Pages 站点的[发布源](https://docs.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).
|
||||||
|
|
||||||
4. 按照 GitHub 指示的地址去访问你的网站。
|
4. 按照 GitHub 指示的地址去访问你的网站。
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue