squiggle/packages/website/README.md

29 lines
669 B
Markdown
Raw Normal View History

2022-02-06 18:40:28 +00:00
# Website
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
## Build for development and production
This one actually works without running `yarn` at the monorepo level, but it doesn't hurt. You must at least run it at this package level
2022-02-06 18:40:28 +00:00
``` sh
yarn
2022-02-06 18:40:28 +00:00
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
``` sh
yarn build
2022-02-06 18:40:28 +00:00
```
Your local dev server is here, opening up a browser window.
``` sh
yarn start
2022-02-06 18:40:28 +00:00
```
Most changes are reflected live without having to restart the server.
2022-02-06 18:40:28 +00:00
Clean up the build artefacts.
``` sh
yarn clean
2022-02-06 18:40:28 +00:00
```