modular-avatar/docs~
bd_ ddbc3b164b
chore: restructure repository to put package at top-level (#477)
* chore: rearrange package structure to have the package at the root

* ci: update CI workflows

* ci: fixing workflow bugs

* ci: recurse building .zip package

* ci: more fixes

* ci: add back in the nadena.dev VPM repo

* ci: fix tests
2023-10-08 15:39:57 +09:00
..
.yarn chore: restructure repository to put package at top-level (#477) 2023-10-08 15:39:57 +09:00
docs chore: restructure repository to put package at top-level (#477) 2023-10-08 15:39:57 +09:00
i18n chore: restructure repository to put package at top-level (#477) 2023-10-08 15:39:57 +09:00
src chore: restructure repository to put package at top-level (#477) 2023-10-08 15:39:57 +09:00
static chore: restructure repository to put package at top-level (#477) 2023-10-08 15:39:57 +09:00
.gitignore chore: restructure repository to put package at top-level (#477) 2023-10-08 15:39:57 +09:00
.yarnrc.yml chore: restructure repository to put package at top-level (#477) 2023-10-08 15:39:57 +09:00
babel.config.js chore: restructure repository to put package at top-level (#477) 2023-10-08 15:39:57 +09:00
docusaurus.config.js chore: restructure repository to put package at top-level (#477) 2023-10-08 15:39:57 +09:00
package.json chore: restructure repository to put package at top-level (#477) 2023-10-08 15:39:57 +09:00
README.md chore: restructure repository to put package at top-level (#477) 2023-10-08 15:39:57 +09:00
robots.txt chore: restructure repository to put package at top-level (#477) 2023-10-08 15:39:57 +09:00
sidebars.js chore: restructure repository to put package at top-level (#477) 2023-10-08 15:39:57 +09:00
tsconfig.json chore: restructure repository to put package at top-level (#477) 2023-10-08 15:39:57 +09:00
yarn.lock chore: restructure repository to put package at top-level (#477) 2023-10-08 15:39:57 +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.