Skip to content

Commit 8468201

Browse files
committed
Add README
1 parent 695a8b2 commit 8468201

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# React Navigation website
2+
3+
## Run it locally
4+
5+
1. Clone the repository
6+
2. `cd` into the `website` directory.
7+
3. Run `yarn` (or `npm install`)
8+
4. `yarn start`
9+
10+
## Make changes
11+
12+
* The `docs` directory contains the markdown files used to generate the website. Change them and refresh the page when running the documentation locally and you will see the changes reflected.
13+
* If you want to add a new page, you need to add it to [sidebars.json](https://github.com/react-navigation/react-navigation.github.io/blob/source/website/sidebars.json) and then restart the server.

0 commit comments

Comments
 (0)