modular-avatar/docs~
2024-08-18 19:39:33 -07:00
..
.yarn chore: restructure repository to put package at top-level (#477) 2023-10-08 15:39:57 +09:00
docs docs: add warning about relying on RO timing 2024-08-18 19:39:33 -07:00
i18n docs: add warning about relying on RO timing 2024-08-18 19:39:33 -07:00
src docs: add drop shadow to logo in light mode (#972) 2024-08-08 21:53:29 -07: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(docs): upgrade docusaurus dependencies (#528) 2023-11-13 18:20:23 +09:00
package.json docs: fix broken admonitions 2024-06-22 18:25:01 -07: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 docs: add instructions for dealing with disabled repos (#644) 2024-02-02 22:33:22 +09:00
yarn.lock docs: fix broken admonitions 2024-06-22 18:25:01 -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.