From e8d20bf7b05fe1ecf7f0d79e751caa227c441cd0 Mon Sep 17 00:00:00 2001 From: Cotes Chung <11371340+cotes2020@users.noreply.github.com> Date: Mon, 9 Jan 2023 23:32:45 +0800 Subject: [PATCH] docs: update tutorials - remove outdated content - append instructions for SASS overrides (#827) --- _posts/2019-08-08-write-a-new-post.md | 4 ++-- _posts/2019-08-09-getting-started.md | 7 +++---- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/_posts/2019-08-08-write-a-new-post.md b/_posts/2019-08-08-write-a-new-post.md index a1c41c2..2254d1a 100644 --- a/_posts/2019-08-08-write-a-new-post.md +++ b/_posts/2019-08-08-write-a-new-post.md @@ -246,7 +246,7 @@ The output will be: ### Preview Image -If you want to add an image at the top of the article, please provide an image with a resolution of `1200 x 630`. Please note that if the image aspect ratio does not meet `1.91 : 1`, the image will be scaled and cropped. +If you want to add an image at the top of the post, please provide an image with a resolution of `1200 x 630`. Please note that if the image aspect ratio does not meet `1.91 : 1`, the image will be scaled and cropped. Knowing these prerequisites, you can start setting the image's attribute: @@ -258,7 +258,7 @@ image: --- ``` -Starting from _Chirpy v5.0.0_, the attributes `height` and `width` can be abbreviated: `height` → `h`, `width` → `w`. In addition, the [`img_path`](#image-path) can also be passed to the preview image, that is, when it has been set, the attribute `path` only needs the image file name. +Note that the [`img_path`](#image-path) can also be passed to the preview image, that is, when it has been set, the attribute `path` only needs the image file name. For simple use, you can also just use `image` to define the path. diff --git a/_posts/2019-08-09-getting-started.md b/_posts/2019-08-09-getting-started.md index d5eb9c5..a4991be 100644 --- a/_posts/2019-08-09-getting-started.md +++ b/_posts/2019-08-09-getting-started.md @@ -31,7 +31,7 @@ Create a new repository from the [**Chirpy Starter**][use-starter] and name it ` And then execute: ```console -$ bash tools/init.sh +$ bash tools/init ``` > If you don't want to deploy your site on GitHub Pages, append option `--no-gh` at the end of the above command. @@ -68,9 +68,9 @@ Update the variables of `_config.yml`{: .filepath} as needed. Some of them are t ### Customizing Stylesheet -If you need to customize the stylesheet, copy the theme's `assets/css/style.scss`{: .filepath} to the same path on your Jekyll site, and then add the custom style at the end of the style file. +If you need to customize the stylesheet, copy the theme's `assets/css/style.scss`{: .filepath} to the same path on your Jekyll site, and then add the custom style at the end of it. -Starting from [`v4.1.0`][chirpy-4.1.0], if you want to overwrite the SASS variables defined in `_sass/addon/variables.scss`{: .filepath}, create a new file `_sass/variables-hook.scss`{: .filepath} and assign new values to the target variable in it. +Starting with version `4.1.0`, if you want to overwrite the SASS variables defined in `_sass/addon/variables.scss`{: .filepath}, copy the main sass file `_sass/jekyll-theme-chirpy.scss`{: .filepath} into the `_sass`{: .filepath} directory in your site's source, then create a new file `_sass/variables-hook.scss`{: .filepath} and assign new value. ### Customing Static Assets @@ -169,6 +169,5 @@ The merge is likely to conflict with your local modifications. Please be patient [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 -[chirpy-4.1.0]: https://github.com/cotes2020/jekyll-theme-chirpy/releases/tag/v4.1.0 [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