From 84ac8c36b025814f1557bf86f8656b61c702af3c Mon Sep 17 00:00:00 2001 From: Paul Meyer <49727155+katexochen@users.noreply.github.com> Date: Thu, 28 Mar 2024 09:48:18 +0100 Subject: [PATCH] docs: update readme Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com> --- docs/README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/README.md b/docs/README.md index 7f2aec8792..e68f10f6a0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 and choose the "Next" version in the top right.