You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+34-21Lines changed: 34 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,39 +40,52 @@ This repository has been made public so that vendors and the open-source communi
40
40
41
41
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
42
42
43
-
When you submit a PR in GitHub, Netlify builds a preview automatically. However, you can preview your changes locally. To do this, you must install `yarn`and run a build to create a Docusaurus preview in your local browser.
43
+
When you submit a PR in GitHub, Netlify builds a preview automatically. However, you can preview your changes locally using Node.js and npm. This repository uses npm as its package manager.
44
44
45
-
### Install yarn
45
+
### Prerequisites
46
46
47
-
The Yarn documentation recommends installing Yarn using the npm package manager, which comes bundled with Node.js when you install it on your system.
47
+
- Node.js version 18 or higher
48
+
- npm (comes bundled with Node.js)
48
49
49
-
After you install npm, you can run the following both to install and upgrade Yarn:
50
+
### Start the local dev server with `npm start`
50
51
51
-
```
52
-
npm install --global yarn
53
-
```
52
+
1. Install dependencies using npm:
53
+
54
+
```bash
55
+
npm install
56
+
```
54
57
55
-
If you use Homebrew, you can run this command to install Yarn:
58
+
2. Start a local development server in a browser window:
56
59
57
-
```
58
-
$ brew install yarn
59
-
```
60
+
```bash
61
+
npm start
62
+
```
60
63
61
-
### Create a Local Development Server and WYSIWYG Preview
64
+
Most changes are reflected live without having to restart the server (changes to the sidebar file typically require restarting the dev server). This preview shows the formatting and styles as they would render on the live site.
62
65
63
-
1. Install the docusaurus package using Yarn:
66
+
If you encounter any build errors, they will appear in the terminal and often indicate issues like broken links or formatting problems in the content.
64
67
65
-
```
66
-
yarn add docusaurus
67
-
```
68
+
## Build and test locally with `npm run build` and `npm run serve`
68
69
69
-
1. Run the following command to start a local development server and open up a browser window. Most changes are reflected live without having to restart the server. This preview shows the formatting and styles as they would render on the live site (also known as what-you-see-is-what-you-get or WYSIWYG), which can be more helpful than viewing content in a VS Code preview.
70
+
Before pushing changes to the remote repository, build and serve the site locally to check for errors, including broken links.
70
71
71
-
```
72
-
$ yarn start
73
-
```
72
+
1. Install dependencies using npm:
74
73
75
-
If `yarn start` refuses to start, try reinstalling the `yarn` CLI. You do not need to uninstall `yarn` before reinstalling it. However, if you get build errors from your content, such as broken links, the Preview itself fails and error messages appear in the terminal that can help you troubleshoot the problems in the content.
74
+
```bash
75
+
npm install
76
+
```
77
+
1. Build the static site files:
78
+
79
+
```bash
80
+
npm run build
81
+
```
82
+
Any broken links and anchor links are listed in the output.
0 commit comments