multi-scrobbler/docsite
2026-04-17 18:30:22 +00:00
..
docs docs: Improve updating guidance 2026-04-16 13:29:34 +00:00
patches almost working 2026-04-07 14:14:25 +00:00
src refactor: Remove unused react-dom imports 2026-04-09 02:19:20 +00:00
static docs: Finalize a working social card strategy 2026-04-08 19:14:43 +00:00
.gitignore feat: Implement somewhat-working docusaurus site 2023-07-13 15:08:00 -04:00
docusaurus.config.ts docs: order BASE_SITE first to allow overriding other envs 2026-04-17 18:30:22 +00:00
package-lock.json social cards working but need descriptions in each front matter 2026-04-07 15:13:23 +00:00
package.json dcs: First pass at more descriptive social card text 2026-04-08 19:30:02 +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.client.json docs: Finalize a working social card strategy 2026-04-08 19:14:43 +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.