Skip to content

Commit

Permalink
update contrib docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cspotcode committed Aug 8, 2021
1 parent 7819066 commit c923ade
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ We use npm scripts for building, testing, and linting. Read the scripts to beco
```
npm install
npm run build
npm run test
npm run test-local
npm run lint-fix
```

Expand All @@ -21,7 +21,7 @@ compiled code in `dist`.

## Documentation

Documentation is written in markdown in `website/docs` and rendered into a website by Docusaurus.
Documentation is written in markdown in `website/docs` and rendered into a website by Docusaurus. The README is also generated from these markdown files.

To edit documentation, modify the markdown files in `./website/docs` and the sidebar declaration in `./website/sidebars.js`

Expand All @@ -36,6 +36,8 @@ cd ./website
yarn
yarn start
# Will host live website locally

yarn build-readme # will rebuild the README.md
```

This site was used to generate the favicon from a high-res PNG export of the SVG. https://realfavicongenerator.net/
Expand Down

0 comments on commit c923ade

Please sign in to comment.