Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Paul Meyer <[email protected]>
  • Loading branch information
katexochen committed Mar 28, 2024
1 parent 27003e5 commit 84ac8c3
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,19 @@

## Previewing

During edits you can preview your changes using the [`docusaurus`](https://docusaurus.io/docs/installation):
The Contrast flake contains a development shell for working on the documentation.

It's automatically activated when you are using `direnv`. Otherwise enter the environment with:

```sh
nix develop .#docs
```

Run a local development server previewing your changes with:

```sh
# requires node >=16.14
npm run start
yarn install
yarn start
```

Browse to <http://localhost:3000/contrast> and choose the "Next" version in the top right.
Expand Down

0 comments on commit 84ac8c3

Please sign in to comment.