modular-avatar/docs
2022-09-07 20:46:39 -07:00
..
docs WIP docs 2022-08-30 16:47:28 -07:00
ja wip 2022-09-07 20:46:39 -07:00
src WIP docs 2022-08-30 16:47:28 -07:00
static WIP docs 2022-08-30 16:47:28 -07:00
.gitignore WIP docs 2022-08-30 16:47:28 -07:00
babel.config.js WIP docs 2022-08-30 16:47:28 -07:00
docusaurus.config.js WIP docs 2022-08-30 16:47:28 -07:00
package-lock.json WIP docs 2022-08-30 16:47:28 -07:00
package.json WIP docs 2022-08-30 16:47:28 -07:00
README.md WIP docs 2022-08-30 16:47:28 -07:00
sidebars.js WIP docs 2022-08-30 16:47:28 -07:00
tsconfig.json WIP docs 2022-08-30 16:47:28 -07: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 opens 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

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

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