multi-scrobbler/docsite
FoxxMD f6c3fc6b50 refactor(docs): replace docusaurus json-schema-plugin
* Use cf-json-schema-viz for schema viewer
* Use modern-react-json-editor for editing
2026-03-13 14:50:39 -04:00
..
docs feat(jellyin): Add external URL guidance 2026-03-12 14:00:59 +00:00
patches refactor(docs): replace docusaurus json-schema-plugin 2026-03-13 14:50:39 -04:00
src refactor(docs): replace docusaurus json-schema-plugin 2026-03-13 14:50:39 -04:00
static refactor(docs): replace docusaurus json-schema-plugin 2026-03-13 14:50:39 -04:00
.gitignore feat: Implement somewhat-working docusaurus site 2023-07-13 15:08:00 -04:00
docusaurus.config.ts refactor(docs): replace docusaurus json-schema-plugin 2026-03-13 14:50:39 -04:00
package-lock.json refactor(docs): replace docusaurus json-schema-plugin 2026-03-13 14:50:39 -04:00
package.json refactor(docs): replace docusaurus json-schema-plugin 2026-03-13 14:50:39 -04:00
README.md feat: Implement somewhat-working docusaurus site 2023-07-13 15:08:00 -04:00
sidebars.ts docs: Update docusaurus to v3 2024-07-09 15:54:45 -04:00
tsconfig.json refactor(docs): replace docusaurus json-schema-plugin 2026-03-13 14:50:39 -04: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.