AnimeFunsion/modular-avatar
1
0
Fork 0
mirror of https://github.com/bdunderscore/modular-avatar.git synced 2025-01-01 12:15:05 +08:00
Code Issues Packages Projects Releases Wiki Activity
fb19fd6cc0
modular-avatar/docs
History
bd_ 6d166b3317 chore: document VCC installation method
2023-01-21 10:56:03 +09:00
..
docs chore: document VCC installation method 2023-01-21 10:56:03 +09:00
i18n chore: document VCC installation method 2023-01-21 10:56:03 +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 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 Fix favicon reference 2022-11-08 18:07:51 -08:00
package.json Bump @algolia/client-search from 4.14.2 to 4.14.3 in /docs 2023-01-02 20:34:28 +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 Bump @algolia/client-search from 4.14.2 to 4.14.3 in /docs 2023-01-02 20:34:28 +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.