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: docs/getting-started/index.mdx
+28
Original file line number
Diff line number
Diff line change
@@ -76,3 +76,31 @@ To avoid duplication, [Docusaurus documentation](https://docusaurus.io/docs) wil
76
76
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.
77
77
78
78
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:
0 commit comments