squiggle/packages/website/README.md

36 lines
661 B
Markdown
Raw Permalink 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.
### Installation
``` sh
yarn
2022-02-06 18:40:28 +00:00
```
### Local Development
``` sh
yarn start
2022-02-06 18:40:28 +00:00
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
``` sh
yarn build
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.
### Clean
2022-02-06 18:40:28 +00:00
Clean up the build artefacts.
``` sh
yarn clean
2022-02-06 18:40:28 +00:00
```
# TODO: unify formatting across `packages/*/README.md`
# TODO: build docs in `ci.yaml`.