plastichub/nodeguy
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
ea046e7d7c
nodeguy/website
History
Atul R ea046e7d7c Fix docs build
2019-09-29 20:40:45 +02:00
..
blog Adds new doc site (#124) 2019-09-29 20:14:35 +02:00
docs Adds new doc site (#124) 2019-09-29 20:14:35 +02:00
src Fix docs build 2019-09-29 20:40:45 +02:00
static Adds new doc site (#124) 2019-09-29 20:14:35 +02:00
.gitignore Adds new doc site (#124) 2019-09-29 20:14:35 +02:00
docusaurus.config.js Adds new doc site (#124) 2019-09-29 20:14:35 +02:00
package.json Adds new doc site (#124) 2019-09-29 20:14:35 +02:00
README.md Adds new doc site (#124) 2019-09-29 20:14:35 +02:00
sidebars.js Adds new doc site (#124) 2019-09-29 20:14:35 +02:00
yarn.lock Adds new doc site (#124) 2019-09-29 20:14:35 +02:00

README.md

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=1 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.