multi-scrobbler/docsite
Matt Foxx aab24819a2
Some checks are pending
Publish Docker image to Dockerhub / test (push) Waiting to run
Publish Docker image to Dockerhub / Build OCI Images (push) Blocked by required conditions
Publish Docker image to Dockerhub / Build OCI Images-1 (push) Blocked by required conditions
Publish Docker image to Dockerhub / Merge OCI Images and Push (push) Blocked by required conditions
Merge pull request #754 from FoxxMD/deezerExtraInfo
feat(deezer): Add additional data to deezer plays
2026-10-15 08:11:29 -04:00
..
docs Merge pull request #754 from FoxxMD/deezerExtraInfo 2026-10-15 08:11:29 -04:00
patches feat(docs): Inline defintions to prevent deduplication erasing descriptions 2026-07-28 01:56:26 +00:00
src Merge pull request #751 from FoxxMD/lzArtistConservative 2026-10-14 08:16:45 -04:00
static docs: write section on configuration help 2026-10-14 19:38:28 +00:00
types fix(docs): Remove skipLibCheck and address React 19 namespace issues per package 2026-05-12 14:23:09 +00:00
.gitignore add openapi.json to gitignore 2026-08-27 00:05:59 +00:00
canonical-replace.ts fix: Use correct gh pages link for replacement 2026-05-05 14:44:00 +00:00
docusaurus.config.ts working poc for openapi doc generation 2026-08-27 00:05:35 +00:00
package-lock.json working poc for openapi doc generation 2026-08-27 00:05:35 +00:00
package.json try moving openapi generate into docs script 2026-08-27 00:27:46 +00:00
README.md feat: Implement somewhat-working docusaurus site 2023-07-13 15:08:00 -04:00
sidebars.ts working poc for openapi doc generation 2026-08-27 00:05:35 +00:00
tsconfig.client.json fix(docs): Remove skipLibCheck and address React 19 namespace issues per package 2026-05-12 14:23:09 +00:00
tsconfig.json almost working 2026-04-07 14:14:25 +00: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.