pure/site
2020-04-27 10:42:40 -07:00
..
components feat(site): add docusaurus site files (#788) 2020-04-27 10:42:40 -07:00
lib feat(site): add docusaurus site files (#788) 2020-04-27 10:42:40 -07:00
src feat(site): add docusaurus site files (#788) 2020-04-27 10:42:40 -07:00
static feat(site): add docusaurus site files (#788) 2020-04-27 10:42:40 -07:00
.gitignore feat(site): add docusaurus site files (#788) 2020-04-27 10:42:40 -07:00
docusaurus.config.js feat(site): add docusaurus site files (#788) 2020-04-27 10:42:40 -07:00
package-lock.json feat(site): add docusaurus site files (#788) 2020-04-27 10:42:40 -07:00
package.json feat(site): add docusaurus site files (#788) 2020-04-27 10:42:40 -07:00
README.md feat(site): add docusaurus site files (#788) 2020-04-27 10:42:40 -07:00

Pure Documentation

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

Installation

$ npm install

Local Development

$ npm run 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

$ npm run 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 npm run 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.