-
Notifications
You must be signed in to change notification settings - Fork 140
Update UG Node.js/npm instructions #2589
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
abeb4b0
af4482d
9939128
b38914d
a9cd909
5d7e5cf
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,11 +14,37 @@ | |
| <div class="indented"> | ||
|
|
||
| %%{{ icon_ticked }}%% a basic knowledge of [Markdown](https://www.markdownguide.org/basic-syntax/) and [HTML](https://www.w3schools.com/html/) syntax<br> | ||
| %%{{ icon_ticked }}%% a basic knowledge of running CLI commands<br> | ||
| %%{{ icon_ticked }}%% a basic knowledge of running [CLI commands](https://www.w3schools.com/whatis/whatis_cli.asp)<br> | ||
| %%{{ icon_ticked }}%% a recent version of [npm](https://www.npmjs.com/get-npm) installed<br> | ||
| %%{{ icon_ticked }}%% [Node.js](https://nodejs.org) {{ node_version }} or higher installed | ||
| </div> | ||
|
|
||
| <panel header=":fa-solid-circle-info: Installing Node.js & npm"> | ||
|
|
||
| <box type="info" light> | ||
| If you already have Node.js ({{ node_version }} or higher) and npm installed, you can skip this section. | ||
| </box> | ||
|
|
||
| Visit the [Node.js download page](https://nodejs.org/en/download). | ||
|
|
||
| - **Option 1: Download a prebuilt installer (Windows/MacOS)** | ||
| - This automatically sets up npm. | ||
| - **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. | ||
|
|
||
| After installation, in your terminal run: | ||
| ``` | ||
| node -v | ||
| npm -v | ||
| ``` | ||
| The versions for `node` and `npm` should match or exceed the requirements mentioned in the Prerequisites. | ||
|
|
||
| </panel> | ||
|
|
||
| --- | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As this section is applicable to only some readers, perhaps put it inside a collapsed panel or a modal?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks for the review! @gerteck also suggested the use of an expandable panel so I'll implement it that way |
||
| 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 +81,12 @@ Usage: ... | |
| <tabs> | ||
| <tab header="Initializing a new project"> | ||
|
|
||
| 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`. | ||
|
|
||
| <include src="tip.md" boilerplate > | ||
| <span id="tip_body"> | ||
|
|
@@ -108,7 +135,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 | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.