-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
55f9401
commit 555da6d
Showing
1 changed file
with
14 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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=<Your GitHub username> 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. |