Skip to content

Commit db4f5b2

Browse files
zanderleagjohnson
andauthored
Basic documentation on how to start the local environment (#75)
Very basic for now, but we can expand as needed. --------- Co-authored-by: Anthony <[email protected]>
1 parent e83f716 commit db4f5b2

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,5 +65,13 @@ Display a nice tooltip when hovering internal links of the same documentation.
6565

6666
----
6767

68+
## Local Development
69+
70+
- Make sure you have the correct version of Node.js installed (>= 18). You can use [asdf](https://github.com/asdf-vm/asdf) or [nvm](https://github.com/nvm-sh/nvm) for easier management of different Node.js versions.
71+
- Run `npm install` to install dependencies
72+
- Run `npm run dev` to start the local dev server. While this can run without a local Read the Docs development instance, not everything will work.
73+
74+
----
75+
6876
> **Note**:
6977
> This work is under active development and is still in **alpha**.

0 commit comments

Comments
 (0)