From f008c03524ca8fc01a278b12a525394d320be392 Mon Sep 17 00:00:00 2001 From: Jens Langhammer Date: Sun, 18 Sep 2022 18:45:05 +0200 Subject: [PATCH] website: cleanup readme Signed-off-by: Jens Langhammer --- website/README.md | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/website/README.md b/website/README.md index cfb5e2569..e39417aee 100644 --- a/website/README.md +++ b/website/README.md @@ -1,17 +1,17 @@ # Website -This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator. +This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. ## Installation ```console -yarn install +npm ci ``` ## Local Development ```console -yarn watch +npm run watch ``` This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server. @@ -19,15 +19,7 @@ This command starts a local development server and open up a browser window. Mos ## Build ```console -yarn build +npm run build ``` This command generates static content into the `build` directory and can be served using any static contents hosting service. - -## Deployment - -```console -GIT_USER= USE_SSH=true yarn deploy -``` - -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.