+ {% include no-linenos.html content=post.content %} + {{ content | markdownify | strip_html | truncate: 200 | escape }} +
+
-## Quick Start
+ - Dark/Light Theme Mode
+ - Localized UI language
+ - Pinned Posts
+ - Hierarchical Categories
+ - Trending Tags
+ - Table of Contents
+ - Last Modified Date of Posts
+ - Syntax Highlighting
+ - Mathematical Expressions
+ - Mermaid Diagram & Flowchart
+ - Dark/Light Mode Images
+ - Embed Videos
+ - Disqus/Utterances/Giscus Comments
+ - Search
+ - Atom Feeds
+ - Google Analytics
+ - Page Views Reporting
+ - SEO & Performance Optimization
-Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of the basic environment. [Git](https://git-scm.com/) also needs to be installed.
-
-### Step 1. Creating a New Site
-
-Sign in to GitHub and browse to [**Chirpy Starter**](https://github.com/cotes2020/chirpy-starter/), click the button Use this template > Create a new repository, and name the new repository `USERNAME.github.io`, where `USERNAME` represents your GitHub username.
-
-### Step 2. Installing Dependencies
-
-Clone it to your local machine, go to its root directory, and run the following command to install the dependencies.
-
-```console
-$ bundle
-```
-
-### Step 3. Running Local Server
-
-Run the following command in the root directory of your site:
-
-```console
-$ bundle exec jekyll s
-```
-
-Or run with Docker:
-
-```console
-$ docker run -it --rm \
- --volume="$PWD:/srv/jekyll" \
- -p 4000:4000 jekyll/jekyll \
- jekyll serve
-```
-
-After a few seconds, the local service will be published at _
- - Dark/Light Theme Mode + - Dark / Light Theme Mode - Localized UI language - Pinned Posts - Hierarchical Categories @@ -34,9 +34,9 @@ - Syntax Highlighting - Mathematical Expressions - Mermaid Diagram & Flowchart - - Dark/Light Mode Images + - Dark / Light Mode Images - Embed Videos - - Disqus/Utterances/Giscus Comments + - Disqus / Utterances / Giscus Comments - Search - Atom Feeds - Google Analytics @@ -71,7 +71,7 @@ _Open Source Development_ license. ## Sponsoring -If you would like to sponsor this project, the following options are available. +If you'd like to sponsor this project, the following options are available. [](https://ko-fi.com/coteschung) [][donation] @@ -81,8 +81,6 @@ If you would like to sponsor this project, the following options are available. This work is published under [MIT][mit] License. - - [jekyllrb]: https://jekyllrb.com/ [bootstrap]: https://getbootstrap.com/ [icons]: https://fontawesome.com/ diff --git a/_posts/2019-08-09-getting-started.md b/_posts/2019-08-09-getting-started.md index ffc8682..120ab7f 100644 --- a/_posts/2019-08-09-getting-started.md +++ b/_posts/2019-08-09-getting-started.md @@ -18,17 +18,17 @@ Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installat There are two ways to create a new repository for this theme: - [**Using the Chirpy Starter**](#option-1-using-the-chirpy-starter) - Easy to upgrade, isolates irrelevant project files so you can focus on writing. -- [**Forking on GitHub**](#option-2-forking-on-github) - Convenient for custom development, but difficult to upgrade. Unless you are familiar with Jekyll and are determined to tweak or contribute to this project, this approach is not recommended. +- [**GitHub Fork**](#option-2-github-fork) - Convenient for custom development, but difficult to upgrade. Unless you are familiar with Jekyll and are determined to tweak or contribute to this project, this approach is not recommended. #### Option 1. Using the Chirpy Starter -Sign in to GitHub and browse to [**Chirpy Starter**](https://github.com/cotes2020/chirpy-starter/), click the button Use this template > Create a new repository, and name the new repository `USERNAME.github.io`, where `USERNAME` represents your GitHub username. +Sign in to GitHub and browse to [**Chirpy Starter**][starter], click the button Use this template > Create a new repository, and name the new repository `USERNAME.github.io`, where `USERNAME` represents your GitHub username. -#### Option 2. Forking on GitHub +#### Option 2. GitHub Fork -[Fork **Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/fork) on GitHub and rename it to `USERNAME.github.io`. Note that the default branch code is under development. To ensure the stability of your site, please switch to the [latest tag][latest-tag] and start writing. +Sign in to GitHub to [fork **Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/fork), and then rename it to `USERNAME.github.io` (`USERNAME` means your username). -And then execute: +Next, clone your site to local machine. In order to build JavaScript files later, we need to install [Node.js][nodejs], and then run the tool: ```console $ bash tools/init @@ -39,15 +39,14 @@ $ bash tools/init The above command will: -1. Remove the files in `_posts`{: .filepath} from your repository. - -2. If the option `--no-gh` is provided, the directory `.github`{: .filepath} will be deleted. Otherwise, set up the GitHub Action workflow by removing the extension `.hook`{: .filepath} of `.github/workflows/pages-deploy.yml.hook`{: .filepath}, and then remove the other files and directories in the folder `.github`{: .filepath}. - -3. Create a new commit to save the changes automatically. +1. Check out the code to the [latest tag][latest-tag] (to ensure the stability of your site: as the code for the default branch is under development). +2. Remove non-essential sample files and take care of GitHub-related files. +3. Build JavaScript files and export to `assets/js/dist/`{: .filepath }, then make them tracked by Git. +4. Automatically create a new commit to save the changes above. ### Installing Dependencies -Before running for the first time, go to the root directory of your site, and install dependencies as follows: +Before running local server for the first time, go to the root directory of your site and run: ```console $ bundle @@ -142,30 +141,7 @@ $ docker run -it --rm \ Unless you specified the output path, the generated site files will be placed in folder `_site`{: .filepath} of the project's root directory. Now you should upload those files to the target server. -## Upgrading - -It depends on how you use the theme: - -- If you are using the theme gem (there will be `gem "jekyll-theme-chirpy"` in the `Gemfile`{: .filepath}), editing the `Gemfile`{: .filepath} and update the version number of the theme gem, for example: - - ```diff - - gem "jekyll-theme-chirpy", "~> 3.2", ">= 3.2.1" - + gem "jekyll-theme-chirpy", "~> 4.3", ">= 4.3.2" - ``` - {: .nolineno file="Gemfile" } - - And then execute the following command: - - ```console - $ bundle update jekyll-theme-chirpy - ``` - - As the version upgrades, the critical files (for details, see the [Startup Template][starter]) and configuration options will change. Please refer to the [Upgrade Guide](https://github.com/cotes2020/jekyll-theme-chirpy/wiki/Upgrade-Guide) to keep your repo's files in sync with the latest version of the theme. - -- If you forked from the source project (there will be `gemspec` in the `Gemfile`{: .filepath} of your site), then merge the [latest upstream tags][latest-tag] into your Jekyll site to complete the upgrade. -The merge is likely to conflict with your local modifications. Please be patient and careful to resolve these conflicts. - +[nodejs]: https://nodejs.org/ [starter]: https://github.com/cotes2020/chirpy-starter -[workflow]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/workflows/pages-deploy.yml.hook [pages-workflow-src]: https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow [latest-tag]: https://github.com/cotes2020/jekyll-theme-chirpy/tags From 0d9cec6abcb699fc6317dbc97b5ec8b9b5edb698 Mon Sep 17 00:00:00 2001 From: Cotes Chung <11371340+cotes2020@users.noreply.github.com> Date: Sat, 18 Mar 2023 02:07:58 +0800 Subject: [PATCH 35/35] chore(release): 5.6.0 --- CHANGELOG.md | 17 +++++++++++++++++ _sass/jekyll-theme-chirpy.scss | 2 +- jekyll-theme-chirpy.gemspec | 2 +- package.json | 2 +- 4 files changed, 20 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4864fbc..43f0011 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,23 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +## [5.6.0](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v5.5.2...v5.6.0) (2023-03-17) + + +### Features + +* change TOC plugin to `tocbot` ([#774](https://github.com/cotes2020/jekyll-theme-chirpy/issues/774)) ([02b7bd5](https://github.com/cotes2020/jekyll-theme-chirpy/commit/02b7bd5095a2affe5b4c5ed7b5b182baaf642ff3)) +* **i18n:** add Greek Language Support. ([#903](https://github.com/cotes2020/jekyll-theme-chirpy/issues/903)) ([712a9b2](https://github.com/cotes2020/jekyll-theme-chirpy/commit/712a9b22401ce591cf4c0bb03fbdd1693fee30bb)) +* **ux:** turn home page posts into clickable cards ([#895](https://github.com/cotes2020/jekyll-theme-chirpy/issues/895)) ([b85f633](https://github.com/cotes2020/jekyll-theme-chirpy/commit/b85f6330dea666350631c4461b742cdb54c5f052)) + + +### Bug Fixes + +* css selector string escaping vulnerability ([#888](https://github.com/cotes2020/jekyll-theme-chirpy/issues/888)) ([5c6ec9d](https://github.com/cotes2020/jekyll-theme-chirpy/commit/5c6ec9d06b6571e2c0efe6652078442dca8af477)) +* mathematics cannot scroll horizontally ([#760](https://github.com/cotes2020/jekyll-theme-chirpy/issues/760)) ([4681df7](https://github.com/cotes2020/jekyll-theme-chirpy/commit/4681df715118a37ae1e91b588de0adb67f4e331a)) +* notch status bar doesn't match theme color ([#918](https://github.com/cotes2020/jekyll-theme-chirpy/issues/918)) ([820ba62](https://github.com/cotes2020/jekyll-theme-chirpy/commit/820ba62e9e939090523a7077d01d01bd78ec84eb)) +* some console snippets will be incompletely copied ([e8e4901](https://github.com/cotes2020/jekyll-theme-chirpy/commit/e8e4901e340dd7e5fc5f656dd3c7bcd6c97b886a)) + ## [5.5.2](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v5.5.1...v5.5.2) (2023-01-30) diff --git a/_sass/jekyll-theme-chirpy.scss b/_sass/jekyll-theme-chirpy.scss index 38c43e0..25e1a14 100644 --- a/_sass/jekyll-theme-chirpy.scss +++ b/_sass/jekyll-theme-chirpy.scss @@ -1,7 +1,7 @@ /*! * The styles for Jekyll theme Chirpy * - * Chirpy v5.5.2 (https://github.com/cotes2020/jekyll-theme-chirpy) + * Chirpy v5.6.0 (https://github.com/cotes2020/jekyll-theme-chirpy) * © 2019 Cotes Chung * MIT Licensed */ diff --git a/jekyll-theme-chirpy.gemspec b/jekyll-theme-chirpy.gemspec index 9ad026f..1a98ecf 100644 --- a/jekyll-theme-chirpy.gemspec +++ b/jekyll-theme-chirpy.gemspec @@ -2,7 +2,7 @@ Gem::Specification.new do |spec| spec.name = "jekyll-theme-chirpy" - spec.version = "5.5.2" + spec.version = "5.6.0" spec.authors = ["Cotes Chung"] spec.email = ["cotes.chung@gmail.com"] diff --git a/package.json b/package.json index e95e75c..6427099 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "jekyll-theme-chirpy", - "version": "5.5.2", + "version": "5.6.0", "description": "A minimal, responsive and feature-rich Jekyll theme for technical writing.", "repository": { "type": "git",