AnimeFunsion/modular-avatar
1
0
Fork 0
mirror of https://github.com/bdunderscore/modular-avatar.git synced 2025-01-01 20:25:07 +08:00
Code Issues Packages Projects Releases Wiki Activity
1af8650ead
modular-avatar/docs
History
bd_ 1af8650ead chore: Add docs for error report window
2023-02-18 16:00:00 +09:00
..
.yarn chore: update docs dependencies 2023-02-17 21:52:03 +09:00
docs chore: Add docs for error report window 2023-02-18 16:00:00 +09:00
i18n chore: Add docs for error report window 2023-02-18 16:00:00 +09:00
src docs: Link directly to latest release 2023-01-02 22:39:27 +09:00
static Adding logo to docs page 2022-10-22 12:48:58 -07:00
.gitignore chore: switch to yarn 2.0 linker 2023-02-17 21:52:03 +09:00
.yarnrc.yml chore: switch to yarn 2.0 linker 2023-02-17 21:52:03 +09:00
babel.config.js WIP docs 2022-08-30 16:47:28 -07:00
docusaurus.config.js Fix favicon reference 2022-11-08 18:07:51 -08:00
package.json chore: update docs dependencies 2023-02-17 21:52:03 +09: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
yarn.lock chore: update docs dependencies 2023-02-17 21:52:03 +09:00

README.md

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.