Skip to content

Commit 3e4efbd

Browse files
authored
Merge pull request #346 from anewman15/run-docs-locally
Docs site: Add instructions for running docs site local server
2 parents 6e6fdb9 + 6998f13 commit 3e4efbd

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

readme.md

+13
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
### Contributing
22

3+
#### Run Avo Docs Site Locally
4+
5+
Avo uses [VitePress](https://vitepress.dev/guide/getting-started) to generate the docs site.
6+
7+
To spin up a local server, run:
8+
9+
```bash
10+
yarn install && yarn dev
11+
```
12+
13+
The site will be available on `http://localhost:3011/`
14+
15+
316
#### Field docs structure
417

518
We begin the file with the name of the field. Next we write the field declaration and a short description of what the field does. Next we should attach an image or gif with it.

0 commit comments

Comments
 (0)