nodeguy/website
2020-03-28 23:09:16 +01:00
..
blog Adds new doc site (#124) 2019-09-29 20:14:35 +02:00
docs Adds image example 2020-03-28 23:09:16 +01:00
src Fix docs website 2020-03-15 12:35:48 +01:00
static Adds new doc site (#124) 2019-09-29 20:14:35 +02:00
.gitignore Fix docs website 2020-03-15 12:35:48 +01:00
docusaurus.config.js cleanup memory for scrollarea 2020-03-24 20:35:29 +01:00
package.json Fix docs website 2020-03-15 12:35:48 +01:00
README.md Fix docs website 2020-03-15 12:35:48 +01:00
sidebars.js Fix docs website 2020-03-15 12:35:48 +01:00
yarn.lock Update docs 14 (#470) 2020-03-28 20:46:26 +01:00

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

$ GIT_USER=<Your GitHub username> 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.