nodeguy/website
Atul R eca218ac79
Adds new doc site (#124)
* Adds base template for new docs site

* Adds Apis to docs

* add some css from rn

* Fix right side sidebar functionality

* Basic docs

* adds old docs

* Cleans up unnecessary files

* Chane links

* Adds docusaurus v2

* Styling fixes

* adds wip and new assets

* adds code image

* Add FAQ link

* Adds analytics

* adds cname

* cleanup blogs
2019-09-29 20:14:35 +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 Adds new doc site (#124) 2019-09-29 20:14:35 +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

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.