From 60a8a2fa4186880445c378538bf291373a3ffaf1 Mon Sep 17 00:00:00 2001 From: Cotes Chung <11371340+cotes2020@users.noreply.github.com> Date: Thu, 20 Aug 2020 01:11:56 +0800 Subject: [PATCH] Improve markdown code style. --- .github/CODE_OF_CONDUCT.md | 19 +++++++-------- .github/ISSUE_TEMPLATE/bug_report.md | 28 ++++++++++------------ .github/PULL_REQUEST_TEMPLATE.md | 17 +++++++------ README.md | 17 ++++++------- _posts/2019-08-08-text-and-typography.md | 19 ++++++++------- _posts/2019-08-08-write-a-new-post.md | 10 ++++---- _posts/2019-08-09-getting-started.md | 15 ++++-------- _posts/2019-08-11-customize-the-favicon.md | 4 ++-- docs/README_zh-CN.md | 18 +++----------- 9 files changed, 60 insertions(+), 87 deletions(-) diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md index bf7a5a3..bf8db4d 100644 --- a/.github/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -11,8 +11,7 @@ appearance, race, religion, or sexual identity and orientation. ## Our Standards -Examples of behavior that contributes to creating a positive environment -include: +Examples of behavior that contributes to creating a positive environment include: * Using welcoming and inclusive language * Being respectful of differing viewpoints and experiences @@ -22,12 +21,10 @@ include: Examples of unacceptable behavior by participants include: -* The use of sexualized language or imagery and unwelcome sexual attention or - advances +* The use of sexualized language or imagery and unwelcome sexual attention or advances * Trolling, insulting/derogatory comments, and personal or political attacks * Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission +* Publishing others' private information, such as a physical or electronic address, without explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting @@ -55,7 +52,7 @@ further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at cotes.chung@gmail.com. All +reported by contacting the project team at `cotes.chung@gmail.com`. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. @@ -68,9 +65,9 @@ members of the project's leadership. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html - -[homepage]: https://www.contributor-covenant.org +available at For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq \ No newline at end of file + + +[homepage]: https://www.contributor-covenant.org \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c8d8379..3c4f292 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -12,11 +12,10 @@ labels: bug - [ ] There are no similar reports on existing issues (including closed ones). - [ ] I found the bug on the latest code of `master` branch. - ## Describe the bug -**To Reproduce** +### To Reproduce Steps to reproduce the behavior: @@ -25,25 +24,24 @@ Steps to reproduce the behavior: 3. Scroll down to '....' 4. See error - -**Expected behavior** +### Expected behavior -**Screenshots** +### Screenshots -**Desktop** +### Desktop - - OS: [e.g. iOS] - - Browser: [e.g. chrome, safari] - - Version: [e.g. 22] +- OS: [e.g. iOS] +- Browser: [e.g. chrome, safari] +- Version: [e.g. 22] -**Smartphone** +### Smartphone - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser: [e.g. stock browser, safari] - - Version: [e.g. 22] +- Device: [e.g. iPhone6] +- OS: [e.g. iOS8.1] +- Browser: [e.g. stock browser, safari] +- Version: [e.g. 22] -**Additional context** +### Additional context diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ddafb4e..4a9d106 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -16,7 +16,7 @@ Please select the desired item checkbox and change it to "[x]", then delete opti - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] Documentation update -## How has this been tested? +## How has this been tested - [ ] My code follows the [Google style guidelines](https://google.github.io/styleguide/) - [ ] I have performed a self-review of my own code diff --git a/README.md b/README.md index 1210ab5..3f51a3f 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ $ git clone git@github.com:/jekyll-theme-chirpy -b master --single-bra ### Setting up the local envrionment -If you would like to run or build the project on your local machine, please follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems` and `Bundler`. +If you would like to run or build the project on your local machine, please follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems` and `Bundler`. Before running or building for the first time, please complete the installation of the Jekyll plugins. Go to the root directory of project and run: @@ -90,17 +90,18 @@ $ bash tools/init.sh What it does is: 1. Remove some files or directories from your repository: - - `.travis.yml` - - files under `_posts` - - folder `docs` + * `.travis.yml` + * files under `_posts` + * folder `docs` -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`. +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. ### Configuration Generally, go to `_config.yml` and configure the variables as needed. Some of them are typical options: + * `url` * `avatar` * `timezone` @@ -121,7 +122,7 @@ Few days later, you may find that the file changes does not refresh in real time ### Deployment -Before the deployment begins, checkout the file `_config.yml` and make sure the `url` is configured correctly. Furthermore, if you prefer the [_project site_](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites) and don't use a custom domain, or you want to visit your website with a base url on a web server other than **GitHub Pages**, remember to change the `baseurl` to your project name that starting with a slash. For example, `/project`. +Before the deployment begins, checkout the file `_config.yml` and make sure the `url` is configured correctly. Furthermore, if you prefer the [*project site*](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites) and don't use a custom domain, or you want to visit your website with a base url on a web server other than **GitHub Pages**, remember to change the `baseurl` to your project name that starting with a slash. For example, `/project`. Assuming you have already gone through the [initialization](#initialization), you can now choose any of the following methods to deploy your website. @@ -130,12 +131,8 @@ Assuming you have already gone through the [initialization](#initialization), yo For security reasons, GitHub Pages build runs on `safe` mode, which restricts us from using tool scripts to generate additional page files. Therefore, we can use GitHub Actions to build the site, store the built site files on a new branch, and use that branch as the source of the Pages service. 1. Push any commit to `origin/master` to trigger the GitHub Actions workflow. Once the build is complete, a new remote branch called `gh-pages` will appear, which is used to store the built site files. - 2. Unless you prefer to project sites, rename your repository to `.github.io` on GitHub. - 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. #### Deploy on Other Platforms diff --git a/_posts/2019-08-08-text-and-typography.md b/_posts/2019-08-08-text-and-typography.md index c5dd293..f06580c 100644 --- a/_posts/2019-08-08-text-and-typography.md +++ b/_posts/2019-08-08-text-and-typography.md @@ -11,16 +11,17 @@ This Jekyll template totally compatible with Markdown syntax. Now, let's take a ## Titles -*** +--- + # H1

H2

H3

-#### H4 +

H4

-*** +--- ## Paragraph @@ -42,11 +43,11 @@ Fluttering and dancing in the breeze. ## Tables -|Company|Contact|Country| -|:---|:--|---:| -|Alfreds Futterkiste | Maria Anders | Germany -|Island Trading | Helen Bennett | UK -|Magazzini Alimentari Riuniti | Giovanni Rovelli | Italy +| Company | contact | Country | +|:-----------------------------|:-----------------|--------:| +| Alfreds Futterkiste | Maria Anders | Germany | +| Island Trading | Helen Bennett | UK | +| Magazzini Alimentari Riuniti | Giovanni Rovelli | Italy | ## Link @@ -60,7 +61,7 @@ Click the hook will locate the footnote[^footnote]. ## Image -![Desktop View]({{ "/assets/img/sample/mockup.png" | relative_url }}) +![Desktop View](/assets/img/sample/mockup.png) ## Inline code diff --git a/_posts/2019-08-08-write-a-new-post.md b/_posts/2019-08-08-write-a-new-post.md index 4d16d8b..465d44b 100644 --- a/_posts/2019-08-08-write-a-new-post.md +++ b/_posts/2019-08-08-write-a-new-post.md @@ -33,7 +33,7 @@ In order to accurately record the release date of a post, you should not only se The `categories` of each post is designed to contain up to two elements, and the number of elements in `tags` can be zero to infinity. -The list of posts belonging to the same _category_/_tag_ is recorded on a separate page. At the same time, the number of these _category_/_tag_ type pages is equal to the number of `categories` / `tags` elements for all posts, which means that the two number must be exactly the same. +The list of posts belonging to the same *category*/*tag* is recorded on a separate page. At the same time, the number of these *category*/*tag* type pages is equal to the number of `categories` / `tags` elements for all posts, which means that the two number must be exactly the same. For instance, let's say there is a post with front matter: @@ -42,7 +42,7 @@ categories: [Animal, Insect] tags: bee ``` -Then we should have two _category_ type pages placed in folder `categories` of root and one _tag_ type page placed in folder `tags` of root: +Then we should have two *category* type pages placed in folder `categories` of root and one *tag* type page placed in folder `tags` of root: ```sh . @@ -54,7 +54,7 @@ Then we should have two _category_ type pages placed in folder `categories` of r ... ``` -and the content of a _category_ type page is +and the content of a *category* type page is ```yaml --- @@ -64,7 +64,7 @@ category: CATEGORY_NAME # e.g. Insect --- ``` -the content of a _tag_ type page is +the content of a *tag* type page is ```yaml --- @@ -74,7 +74,7 @@ tag: TAG_NAME # e.g. bee --- ``` -With the increasing number of posts, the number of categories and tags will increase several times! If we still manually create these *category*/_tag_ type files, it will obviously be a super time-consuming job, and it is very likely to miss some of them, i.e., when you click on the missing `category` or `tag` link from a post or somewhere, the browser will complain to you "404 Not Found". The good news is we got a lovely script tool `_scripts/sh/create_pages.sh` to finish the boring tasks. Basically we will use it via `run.sh`, `build.sh`, `deploy.sh` or `publish.sh` that placed in `tools/` instead of running it separately. Check out its use case [here]({{ "/posts/getting-started/#deployment" | relative_url }}). +With the increasing number of posts, the number of categories and tags will increase several times! If we still manually create these *category*/*tag* type files, it will obviously be a super time-consuming job, and it is very likely to miss some of them, i.e., when you click on the missing `category` or `tag` link from a post or somewhere, the browser will complain to you "404 Not Found". The good news is we got a lovely script tool `_scripts/sh/create_pages.sh` to finish the boring tasks. Basically we will use it via `run.sh`, `build.sh`, `deploy.sh` or `publish.sh` that placed in `tools/` instead of running it separately. Check out its use case [here]({{ "/posts/getting-started/#deployment" | relative_url }}). ## Last modified date diff --git a/_posts/2019-08-09-getting-started.md b/_posts/2019-08-09-getting-started.md index 8c62f36..fdc386d 100644 --- a/_posts/2019-08-09-getting-started.md +++ b/_posts/2019-08-09-getting-started.md @@ -42,7 +42,6 @@ What's more, in order to generate some extra files (*categories*, *tags* and *la $ brew install coreutils ``` - ## Usage Running [**Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/) requires some extra files, which cannot be generated by Jekyll native commands, so please strictly follow the methods mentioned below to run or deploy your website. @@ -60,12 +59,10 @@ $ bash tools/init.sh What it does is: 1. Remove some files or directories from your repository: - - `.travis.yml` - - files under `_posts` - - folder `docs` - +* `.travis.yml` +* files under `_posts` +* folder `docs` 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. ### Configuration @@ -76,7 +73,6 @@ Generally, go to `_config.yml` and configure the variables as needed. Some of th * `timezone` * `theme_mode` - ### Run Locally You may want to preview the site contents before publishing, so just run it by: @@ -91,7 +87,7 @@ Few days later, you may find that the file changes does not refresh in real time ### Deployment -Before the deployment begins, checkout the file `_config.yml` and make sure the `url` is configured correctly. Furthermore, if you prefer the [_project site_](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites) and don't use a custom domain, or you want to visit your website with a base url on a web server other than **GitHub Pages**, remember to change the `baseurl` to your project name that starting with a slash. For example, `/project`. +Before the deployment begins, checkout the file `_config.yml` and make sure the `url` is configured correctly. Furthermore, if you prefer the [*project site*](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites) and don't use a custom domain, or you want to visit your website with a base url on a web server other than **GitHub Pages**, remember to change the `baseurl` to your project name that starting with a slash. For example, `/project`. Assuming you have already gone through the [initialization](#initialization), you can now choose any of the following methods to deploy your website. @@ -100,11 +96,8 @@ Assuming you have already gone through the [initialization](#initialization), yo For security reasons, GitHub Pages build runs on `safe` mode, which restricts us from using tool scripts to generate additional page files. Therefore, we can use GitHub Actions to build the site, store the built site files on a new branch, and use that branch as the source of the Pages service. 1. Push any commit to `origin/master` to trigger the GitHub Actions workflow. Once the build is complete, a new remote branch called `gh-pages` will appear, which is used to store the built site files. - 2. Unless you prefer to project sites, rename your repository to `.github.io` on GitHub. - 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. #### Deploy on Other Platforms diff --git a/_posts/2019-08-11-customize-the-favicon.md b/_posts/2019-08-11-customize-the-favicon.md index 44921a3..2d762e7 100644 --- a/_posts/2019-08-11-customize-the-favicon.md +++ b/_posts/2019-08-11-customize-the-favicon.md @@ -11,11 +11,11 @@ In [**Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/), the image fi With a square image (PNG, JPG or GIF) in hand, open the site [*Favicon & App Icon Generator*](https://www.favicon-generator.org/) and upload your original image. -![upload-image]({{ "/assets/img/sample/upload-image.png" | relative_url }}) +![upload-image](/assets/img/sample/upload-image.png) Click button Create Favicon and wait a moment for the website to generate the icons of various sizes automatically. -![download-icons]({{ "/assets/img/sample/download-icons.png" | relative_url }}) +![download-icons](/assets/img/sample/download-icons.png) Download the generated package, unzip and delete the following two from the extracted files: diff --git a/docs/README_zh-CN.md b/docs/README_zh-CN.md index d84c784..b2e2c94 100644 --- a/docs/README_zh-CN.md +++ b/docs/README_zh-CN.md @@ -40,7 +40,6 @@ * SEO 优化 * 网站性能优化 - ## 安装 [Fork **Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/fork)，然后克隆到本地： @@ -53,7 +52,6 @@ $ git clone git@github.com:/jekyll-theme-chirpy -b master --single-bra 如果你想在本地运行或构建, 参考 [Jekyll Docs](https://jekyllrb.com/docs/installation/)安装 `Ruby`， `RubyGems` 和 `Bundler`。 - 首次运行或构建时, 请先安装 Jekyll plugins。在项目根目录运行： ```terminal @@ -76,7 +74,6 @@ $ bundle install $ brew install coreutils ``` - ## 使用 运行 [**Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/) 需要一些额外的文件, 它们不能通过 Jekyll 原生的命令生成，所以请严格依照下列说明去运行或部署此项目。 @@ -94,12 +91,10 @@ $ bash tools/init.sh 上述脚本完成了以下工作: 1. 从你的仓库中删除了: - - `.travis.yml` - - `_posts` 下的文件 - - `docs` 目录 - + * `.travis.yml` + * `_posts` 下的文件 + * `docs` 目录 2. 如果使用了参数 `--no-gh`，则会怒删 `.github`。否则，将会配置 GitHub Actions：把 `.github/workflows/pages-deploy.yml.hook` 的后缀 `.hook` 去除，然后删除 `.github` 里的其他目录和文件。 - 3. 自动提交一个 Commit 以保存上述文件的更改。 ### 配置文件 @@ -123,7 +118,6 @@ $ bash tools/run.sh 如果你想在本地服务运行后，把修改源文件的更改实时刷新，可使用选项 `-r` (或 `--realtime`)，不过要先安装依赖 [**fswatch**](http://emcrisostomo.github.io/fswatch/) 。 - ### 部署 部署开始前，把 `_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`。 @@ -135,11 +129,8 @@ $ bash tools/run.sh 由于安全原因，GitHub Pages 的构建强制加了 `safe`参数，这导致了我们不能使用脚本工具去创建所需的附加页面。因此，我们可以使用 GitHub Actions 去构建站点，把站点文件存储在一个新分支上，再指定该分支作为 Pages 服务的源。 1. 推送任意一个 commit 到 `origin/master` 以触发 GitHub Actions workflow。一旦 build 完毕，远端将会自动出现一个新分支 `gh-pages` 用来存储构建的站点文件。 - 2. 除非你是使用 project 站点, 否则重命名你的仓库为 `.github.io`。 - 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 指示的地址去访问你的网站。 #### 部署到其他 Pages 平台 @@ -179,7 +170,6 @@ $ bash tools/build.sh -d /path/to/site/ 若想要更多细节以及更佳的阅读体验，请参阅 [线上教程](https://chirpy.cotes.info/categories/tutorial/)。 与此同时，[Wiki](https://github.com/cotes2020/jekyll-theme-chirpy/wiki) 也有一份教程的拷贝。 - ## 参与贡献 三人行必有我师，欢迎提报告 bug, 帮助改进代码质量，或者提交新功能。具体操作规则请参考 [贡献指南](../.github/CONTRIBUTING.md)，谢谢 🙏。 @@ -190,12 +180,10 @@ $ bash tools/build.sh -d /path/to/site/ :tada: 感谢所有参与代码贡献的小伙伴, 他们的 GayHub ID 在这个[列表](https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors)。 另外, 提交过 issues(或者未被合并 PR) 的高富帅和白富美也不会被遗忘,他/她们帮助报告 bug、分享新点子或者启发了我写出更通俗易懂的文档。 - ## 赞助 如果您喜欢这个主题或者它对您有帮助，请考虑打赏作者：在 [项目主页](https://github.com/cotes2020/jekyll-theme-chirpy) 点击按钮 :heart: Sponsor 选择适合的链接即可完成（国内一般选第二个链接，支付宝/微信赞助），您的打赏将会极大地鼓励作者，并帮助作者更好地维护项目！ - ## 许可证书 本项目开源，基于 [MIT](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) 许可。