modular-avatar/docs~
bd_ cc6ecd4f90
Update parameters docs and Saved field handling (#661)
* docs: new parameters UI documentation

Closes: #635

* feat(params), changelog-callout: adjust handling of Saved flag with parameters

* chore: fix docs links
2024-02-12 19:24:35 +09:00
..
.yarn chore: restructure repository to put package at top-level (#477) 2023-10-08 15:39:57 +09:00
docs Update parameters docs and Saved field handling (#661) 2024-02-12 19:24:35 +09:00
i18n Update parameters docs and Saved field handling (#661) 2024-02-12 19:24:35 +09:00
src docs: add instructions for dealing with disabled repos (#644) 2024-02-02 22:33:22 +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(docs): upgrade docusaurus dependencies (#528) 2023-11-13 18:20:23 +09:00
package.json chore(docs): upgrade docusaurus dependencies (#528) 2023-11-13 18:20:23 +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 docs: add instructions for dealing with disabled repos (#644) 2024-02-02 22:33:22 +09:00
yarn.lock chore(deps): bump follow-redirects from 1.15.3 to 1.15.4 in /docs~ (#620) 2024-01-12 20:02:27 +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.