Skip to content

Commit 89ef8a5

Browse files
author
Eric Lin
committed
feat: running locally instructions
1 parent faa9128 commit 89ef8a5

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

docs/getting-started/index.mdx

+28
Original file line numberDiff line numberDiff line change
@@ -76,3 +76,31 @@ To avoid duplication, [Docusaurus documentation](https://docusaurus.io/docs) wil
7676
7. Go to the `Collaborators and teams` under `Access` on the left sidebar. Add `protocol-pliny` from the green `Add teams` button. Add any other relevant teams, such as your own as needed.
7777

7878
8. At the moment, it is not possible to easily use branch protection on `main` when using the `semantic-release` plugin. If you disable this, then branch protection can be enabled.
79+
80+
## Running locally
81+
82+
You will need to have **Node.js** installed to run the live previews of the docs locally.
83+
84+
It is highly recommended that you use a tool like [`nvm`](https://github.com/nvm-sh/nvm#installing-and-updating) to manage Node.js versions on your machine.
85+
86+
### Installing recommended Node.js version with `nvm`
87+
88+
1. Follow the above instructions to install `nvm` on your machine, or go [here](https://github.com/nvm-sh/nvm#installing-and-updating).
89+
2. Go to root folder of this project in your terminal.
90+
3. Run `nvm install` followed by `nvm use`. This will install the version specified by this project in the `.nvmrc` file.
91+
92+
### Running this project
93+
94+
1. Navigate to root folder of the project after installing Node.js
95+
2. Run the following in sequence, which only needs to be done once:
96+
97+
```bash
98+
npm install
99+
npm prepare
100+
```
101+
102+
3. To preview and for every time afterwards:
103+
104+
```bash
105+
npm run start
106+
```

0 commit comments

Comments
 (0)