Skip to content

Commit 510f0ee

Browse files
committed
remove yarn and only use npm
update dependencies to fix security issues update readme with new directions for using npm instead of yarn
1 parent da5dff0 commit 510f0ee

File tree

4 files changed

+16098
-13968
lines changed

4 files changed

+16098
-13968
lines changed

README.md

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -40,39 +40,30 @@ This repository has been made public so that vendors and the open-source communi
4040

4141
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4242

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.
4444

45-
### Install yarn
45+
### Prerequisites
4646

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.
48-
49-
After you install npm, you can run the following both to install and upgrade Yarn:
50-
51-
```
52-
npm install --global yarn
53-
```
54-
55-
If you use Homebrew, you can run this command to install Yarn:
56-
57-
```
58-
$ brew install yarn
59-
```
47+
- Node.js version 18 or higher
48+
- npm (comes bundled with Node.js)
6049

6150
### Create a Local Development Server and WYSIWYG Preview
6251

63-
1. Install the docusaurus package using Yarn:
52+
1. Install dependencies using npm:
6453

65-
```
66-
yarn add docusaurus
54+
```bash
55+
npm install
6756
```
6857

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.
58+
2. Run the following command to start a local development server and open up a browser window:
7059

60+
```bash
61+
npm start
7162
```
72-
$ yarn start
73-
```
7463

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.
64+
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 (what-you-see-is-what-you-get or WYSIWYG).
65+
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.
7667

7768
## Folder Structure and TOC
7869

0 commit comments

Comments
 (0)