Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 34 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,39 +40,52 @@ This repository has been made public so that vendors and the open-source communi

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

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

### Install yarn
### Prerequisites

The Yarn documentation recommends installing Yarn using the npm package manager, which comes bundled with Node.js when you install it on your system.
- Node.js version 18 or higher
- npm (comes bundled with Node.js)

After you install npm, you can run the following both to install and upgrade Yarn:
### Start the local dev server with `npm start`

```
npm install --global yarn
```
1. Install dependencies using npm:

```bash
npm install
```

If you use Homebrew, you can run this command to install Yarn:
2. Start a local development server in a browser window:

```
$ brew install yarn
```
```bash
npm start
```

### Create a Local Development Server and WYSIWYG Preview
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.

1. Install the docusaurus package using Yarn:
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.

```
yarn add docusaurus
```
## Build and test locally with `npm run build` and `npm run serve`

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.
Before pushing changes to the remote repository, build and serve the site locally to check for errors, including broken links.

```
$ yarn start
```
1. Install dependencies using npm:

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.
```bash
npm install
```
1. Build the static site files:

```bash
npm run build
```
Any broken links and anchor links are listed in the output.

1. Serve the `build` directory locally to test:

```bash
npm run serve
```

## Folder Structure and TOC

Expand Down
Loading