From abeb4b06818af5ffd99a1049cd7d4c21fe3c339b Mon Sep 17 00:00:00 2001 From: seah-minlong <86313670+seah-minlong@users.noreply.github.com> Date: Tue, 28 Jan 2025 15:27:52 +0800 Subject: [PATCH 1/4] Add installing node.js and npm instructions --- docs/userGuide/gettingStarted.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/docs/userGuide/gettingStarted.md b/docs/userGuide/gettingStarted.md index c113fb924..054357203 100644 --- a/docs/userGuide/gettingStarted.md +++ b/docs/userGuide/gettingStarted.md @@ -19,6 +19,30 @@ %%{{ icon_ticked }}%% [Node.js](https://nodejs.org) {{ node_version }} or higher installed +++**Installing Node.js and npm**++ + + +If you already have Node.js ({{ node_version }} or higher) and npm installed, you can skip this section. + + +Visit the [Node.js download page](https://nodejs.org/en/download). + +- **Windows/macOS can download a prebuilt installer** + - This automatically sets up npm. +- **Command Line Option (any OS)** + 1. Select your **OS** and architecture from the dropdowns on the same page. + 2. Make sure to choose **“with npm”**. + 3. Run the provided commands in your terminal to install Node.js and npm. + +After installation, in your terminal run: +```bash +node -v +npm -v +``` +The versions should match or exceed the requirements mentioned in the Prerequisites. + +--- + There are a few ways to install MarkBind, select one that is most suitable for your use case. If you are unsure, we recommend using the first method. ## Method 1: Install MarkBind globally with npm @@ -55,11 +79,12 @@ Usage: ... -Navigate into an empty directory and run the following command to initialize a skeletal MarkBind site in that directory. It will create several new files in the directory e.g., `index.md`, `site.json`. +Navigate into an empty directory and run: ``` markbind init ``` +This command creates a skeletal MarkBind site in that directory, with files like `index.md` and `site.json`. From af4482dc277ad3e474d80cd056e5aef06b909ac5 Mon Sep 17 00:00:00 2001 From: seah-minlong <86313670+seah-minlong@users.noreply.github.com> Date: Tue, 28 Jan 2025 15:51:34 +0800 Subject: [PATCH 2/4] Update instructions for updating MarkBind --- docs/userGuide/gettingStarted.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/userGuide/gettingStarted.md b/docs/userGuide/gettingStarted.md index 054357203..009d885a7 100644 --- a/docs/userGuide/gettingStarted.md +++ b/docs/userGuide/gettingStarted.md @@ -35,7 +35,7 @@ Visit the [Node.js download page](https://nodejs.org/en/download). 3. Run the provided commands in your terminal to install Node.js and npm. After installation, in your terminal run: -```bash +``` node -v npm -v ``` @@ -133,7 +133,7 @@ To stop the web server, go to the console running the `serve` command and press ++**5. Updating your MarkBind version**++ -After you have installed MarkBind, you may want to update to the latest version of MarkBind in the future. +After you have installed MarkBind, you can update to the latest version by running: ``` npm install -g markbind-cli@latest From 9939128ec81d7534091f314eb7f87db4ecf75ab3 Mon Sep 17 00:00:00 2001 From: seah-minlong <86313670+seah-minlong@users.noreply.github.com> Date: Wed, 29 Jan 2025 12:47:29 +0800 Subject: [PATCH 3/4] Place Node.js & npm installation guide in a collapsible panel --- docs/userGuide/gettingStarted.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/userGuide/gettingStarted.md b/docs/userGuide/gettingStarted.md index 009d885a7..00bd3410f 100644 --- a/docs/userGuide/gettingStarted.md +++ b/docs/userGuide/gettingStarted.md @@ -19,7 +19,7 @@ %%{{ icon_ticked }}%% [Node.js](https://nodejs.org) {{ node_version }} or higher installed -++**Installing Node.js and npm**++ + If you already have Node.js ({{ node_version }} or higher) and npm installed, you can skip this section. @@ -41,6 +41,8 @@ npm -v ``` The versions should match or exceed the requirements mentioned in the Prerequisites. + + --- There are a few ways to install MarkBind, select one that is most suitable for your use case. If you are unsure, we recommend using the first method. From b38914dc27deb1159f8602e0873daa7eabebd78d Mon Sep 17 00:00:00 2001 From: seah-minlong <86313670+seah-minlong@users.noreply.github.com> Date: Wed, 5 Feb 2025 15:56:44 +0800 Subject: [PATCH 4/4] Improve installation instructions and add link guide for CLI commands --- docs/userGuide/gettingStarted.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/userGuide/gettingStarted.md b/docs/userGuide/gettingStarted.md index 00bd3410f..a5f317ae6 100644 --- a/docs/userGuide/gettingStarted.md +++ b/docs/userGuide/gettingStarted.md @@ -14,7 +14,7 @@
%%{{ icon_ticked }}%% a basic knowledge of [Markdown](https://www.markdownguide.org/basic-syntax/) and [HTML](https://www.w3schools.com/html/) syntax
- %%{{ icon_ticked }}%% a basic knowledge of running CLI commands
+ %%{{ icon_ticked }}%% a basic knowledge of running [CLI commands](https://www.w3schools.com/whatis/whatis_cli.asp)
%%{{ icon_ticked }}%% a recent version of [npm](https://www.npmjs.com/get-npm) installed
%%{{ icon_ticked }}%% [Node.js](https://nodejs.org) {{ node_version }} or higher installed
@@ -27,9 +27,9 @@ If you already have Node.js ({{ node_version }} or higher) and npm installed, yo Visit the [Node.js download page](https://nodejs.org/en/download). -- **Windows/macOS can download a prebuilt installer** +- **Option 1: Download a prebuilt installer (Windows/MacOS)** - This automatically sets up npm. -- **Command Line Option (any OS)** +- **Option 2: Install through the Command Line (any OS)** 1. Select your **OS** and architecture from the dropdowns on the same page. 2. Make sure to choose **“with npm”**. 3. Run the provided commands in your terminal to install Node.js and npm. @@ -39,7 +39,7 @@ After installation, in your terminal run: node -v npm -v ``` -The versions should match or exceed the requirements mentioned in the Prerequisites. +The versions for `node` and `npm` should match or exceed the requirements mentioned in the Prerequisites.