multi-scrobbler/docsite
2026-02-26 19:23:58 +00:00
..
docs docs: Add status page to monitoring section 2026-02-26 19:23:58 +00:00
src docs(discord): Improved discord app docs 2026-02-25 16:31:55 +00:00
static docs(discord): Add discord container instructions 2026-02-25 19:19:31 +00:00
.gitignore feat: Implement somewhat-working docusaurus site 2023-07-13 15:08:00 -04:00
docusaurus.config.ts docs: Improve general transform docs 2025-12-17 13:57:56 +00:00
package-lock.json docs: Add redirects for old pages 2025-11-13 17:08:30 +00:00
package.json docs: Add redirects for old pages 2025-11-13 17:08:30 +00: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 docs: Update docusaurus to v3 2024-07-09 15:54:45 -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.