From ac58bbb915b2f7579945bbe69d474c754fa463b5 Mon Sep 17 00:00:00 2001 From: Cotes Chung <11371340+cotes2020@users.noreply.github.com> Date: Wed, 24 Jul 2024 00:34:00 +0800 Subject: [PATCH] docs: amend content --- _posts/2019-08-09-getting-started.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/_posts/2019-08-09-getting-started.md b/_posts/2019-08-09-getting-started.md index 03bdd19279d..100dca37df7 100644 --- a/_posts/2019-08-09-getting-started.md +++ b/_posts/2019-08-09-getting-started.md @@ -13,21 +13,23 @@ media_subpath: '/posts/20180809' ## Creating a site repository -There are two ways to create a site repository for **Chirpy**: +There are two methods to create a site repository for **Chirpy**: -- [**Using the Starter**](#option-1-using-the-starter) — This method makes upgrades easy and isolates irrelevant project files, allowing you to focus on writing. -- [**Forking the Theme**](#option-2-forking-the-theme) — This method is convenient for custom development but challenging to upgrade. Unless you are familiar with Jekyll and plan to tweak or contribute to this project, this approach is not recommended. +- [**Using the starter**](#option-1-using-the-starter) — This approach simplifies upgrades and isolates unnecessary project files, enabling you to concentrate on your content. It's ideal for those who want a hassle-free setup focused primarily on writing. +- [**Forking the theme**](#option-2-forking-the-theme) — This method allows for customization and development but presents challenges during upgrades. It is not recommended to use this approach unless you are familiar with Jekyll and plan to modify this project. ### Option 1: using the starter -1. Sign in to GitHub and navigate to the [**Starter**][starter]. +1. Sign in to GitHub and navigate to the [**starter**][starter]. 2. Click the Use this template button and then select Create a new repository. -3. Name the new repository `.github.io`. ### Option 2: forking the theme -1. Sign in to GitHub and [fork the Theme](https://github.com/cotes2020/jekyll-theme-chirpy/fork). -2. Rename the new repository to `.github.io`. +Sign in to GitHub and [fork the theme](https://github.com/cotes2020/jekyll-theme-chirpy/fork). + +## Name your new repository + +Rename your repository to `.github.io`. If your GitHub username contains uppercase letters, convert it to lowercase. ## Setting up the environment @@ -50,7 +52,7 @@ For Unix-like systems, besides using Dev Containers, you can also [natively set 1. Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of the basic environment. Ensure that [Git](https://git-scm.com/) is also installed. 2. Clone your repository to a local disk. -3. If your site was created by forking the main repository, install [Node.js][nodejs] and run `bash tools/init.sh` in the repo root directory to initialize files. +3. If your site is created by forking the theme, install [Node.js][nodejs] and run `bash tools/init.sh` in the root directory. This will initialize the repository files and create a commit to save the changes. 4. Install the dependencies by running `bundle`. ### Start the local server