modular-avatar/docs
2023-05-17 20:35:26 +09:00
..
.yarn chore: update docs dependencies 2023-02-17 21:52:03 +09:00
docs docs: update menu screenshots 2023-05-14 22:02:52 +09:00
i18n docs: Add helpful hints around how to install via VCC 2023-05-14 22:05:01 +09:00
src docs: fix download button 2023-05-17 20:35:26 +09:00
static docs: add missing file 2023-05-14 22:06:16 +09:00
.gitignore chore: switch to yarn 2.0 linker 2023-02-17 21:52:03 +09:00
.yarnrc.yml docs: Add helpful hints around how to install via VCC 2023-05-14 22:05:01 +09:00
babel.config.js WIP docs 2022-08-30 16:47:28 -07:00
docusaurus.config.js chore: add robots.txt 2023-03-25 15:21:00 +09:00
package.json docs: Add helpful hints around how to install via VCC 2023-05-14 22:05:01 +09:00
README.md WIP docs 2022-08-30 16:47:28 -07:00
robots.txt chore: add robots.txt 2023-03-25 15:21:00 +09: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
yarn.lock docs: Add helpful hints around how to install via VCC 2023-05-14 22:05:01 +09: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.