From 555da6d10d7a91ba03484778c75cfa970de2d5e4 Mon Sep 17 00:00:00 2001 From: Will Eastcott Date: Fri, 26 Apr 2024 16:05:36 +0100 Subject: [PATCH] Update README --- README.md | 38 ++++++++++++++------------------------ 1 file changed, 14 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 2124f6b2a..e7d337bfd 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,31 @@ -# Website +# PlayCanvas Blog -This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. +This is the source repository for the [PlayCanvas Blog](https://blog.playcanvas.com/). It is made up of static web content generated from Markdown files using [Docusaurus](https://docusaurus.io). -## Installation +## How to build -```sh -yarn -``` - -## Local Development +Building the site requires an installation of Node.js 18+. ```sh -yarn start +cd blog +npm i +npm run build ``` -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. +## How to serve -## Build +To serve the built site locally: ```sh -yarn build +npm run serve ``` -This command generates static content into the `build` directory and can be served using any static contents hosting service. - -## Deployment +This will automatically open the built site in your browser. -Using SSH: +## Use 'start' for quick iteration -```sh -USE_SSH=true yarn deploy -``` - -Not using SSH: +The `start` build command will automatically rebuild the site when changes are made in the `docs`, `src` or `static` folders. ```sh -GIT_USER= yarn deploy +npm run start ``` - -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.