From a8b8a379f67a6a7697009bb194721040af2d36eb Mon Sep 17 00:00:00 2001 From: Cotes Chung <11371340+cotes2020@users.noreply.github.com> Date: Sat, 30 Jan 2021 01:24:30 +0800 Subject: [PATCH] Improve the docs - Add missing url references in the tutorial - Add gem version badge in README --- README.md | 6 ++++-- _posts/2019-08-09-getting-started.md | 6 ++++-- docs/README.zh-CN.md | 5 +++-- 3 files changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b49240b..2054748 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ Language: English | [简体中文](https://github.com/cotes2020/jekyll-theme-chi [![Build Status](https://github.com/cotes2020/jekyll-theme-chirpy/workflows/build/badge.svg?branch=master&event=push)](https://github.com/cotes2020/jekyll-theme-chirpy/actions?query=branch%3Amaster+event%3Apush) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/8220b926db514f13afc3f02b7f884f4b)](https://app.codacy.com/manual/cotes2020/jekyll-theme-chirpy?utm_source=github.com&utm_medium=referral&utm_content=cotes2020/jekyll-theme-chirpy&utm_campaign=Badge_Grade_Dashboard) [![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) +[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy?color=important)](https://rubygems.org/gems/jekyll-theme-chirpy) [![996.icu](https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg)](https://996.icu) A minimal, sidebar, responsive web design Jekyll theme that focuses on text presentation. Designed to help you record and share your knowledge easily. [Live Demo »](https://chirpy.cotes.info) @@ -218,5 +219,6 @@ This work is published under [MIT](https://github.com/cotes2020/jekyll-theme-chi [starter]: https://github.com/cotes2020/chirpy-starter [use-starter]: https://github.com/cotes2020/chirpy-starter/generate -[workflow]:https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/workflows/pages-deploy.yml.hook -[jb]:https://www.jetbrains.com/?from=jekyll-theme-chirpy +[workflow]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/workflows/pages-deploy.yml.hook +[jb]: https://www.jetbrains.com/?from=jekyll-theme-chirpy + diff --git a/_posts/2019-08-09-getting-started.md b/_posts/2019-08-09-getting-started.md index e36bd3f..d034c65 100644 --- a/_posts/2019-08-09-getting-started.md +++ b/_posts/2019-08-09-getting-started.md @@ -69,7 +69,6 @@ $ bash tools/init.sh What it does is: 1. Remove some files or directories from your repository: - - `.travis.yml` - files under `_posts` - folder `docs` @@ -78,7 +77,6 @@ What it does is: 3. Automatically create a commit to save the changes. - ## Usage ### Configuration @@ -157,3 +155,7 @@ $ docker run -it --rm \ ``` Unless you specified the output path, the generated site files will be placed in folder `_site` of the project's root directory. Now you should upload those files to your web server. + +[starter]: https://github.com/cotes2020/chirpy-starter +[use-starter]: https://github.com/cotes2020/chirpy-starter/generate +[workflow]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/workflows/pages-deploy.yml.hook diff --git a/docs/README.zh-CN.md b/docs/README.zh-CN.md index 4836c47..792314f 100644 --- a/docs/README.zh-CN.md +++ b/docs/README.zh-CN.md @@ -5,6 +5,7 @@ Language: [English](https://github.com/cotes2020/jekyll-theme-chirpy#readme) | [![Build Status](https://github.com/cotes2020/jekyll-theme-chirpy/workflows/build/badge.svg?branch=master&event=push)](https://github.com/cotes2020/jekyll-theme-chirpy/actions?query=branch%3Amaster+event%3Apush) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/8220b926db514f13afc3f02b7f884f4b)](https://app.codacy.com/manual/cotes2020/jekyll-theme-chirpy?utm_source=github.com&utm_medium=referral&utm_content=cotes2020/jekyll-theme-chirpy&utm_campaign=Badge_Grade_Dashboard) [![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) +[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy?color=important)](https://rubygems.org/gems/jekyll-theme-chirpy) [![996.icu](https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg)](https://996.icu) 一个不一样的 Jekyll 主题，采用响应式设计，方便记录、管理、分享你的知识和经验。[懂的进 »](https://chirpy.cotes.info) @@ -221,5 +222,5 @@ $ docker run -it --rm \ [starter]: https://github.com/cotes2020/chirpy-starter [use-starter]: https://github.com/cotes2020/chirpy-starter/generate -[workflow]:https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/workflows/pages-deploy.yml.hook -[jb]:https://www.jetbrains.com/?from=jekyll-theme-chirpy +[workflow]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/workflows/pages-deploy.yml.hook +[jb]: https://www.jetbrains.com/?from=jekyll-theme-chirpy