multi-scrobbler/docsite
2025-01-16 14:07:47 -05:00
..
docs docs: Update kitchensink with newer jellyfin/plex examples 2025-01-15 15:09:38 +00:00
src docs: Strikeout tautulli in readme 2025-01-15 15:16:01 +00:00
static docs: Improve schema generation and compatibility 2024-12-04 14:46:40 -05:00
.gitignore feat: Implement somewhat-working docusaurus site 2023-07-13 15:08:00 -04:00
docusaurus.config.ts docs: Update to Docusaurs 3.6 to improve build times 2025-01-16 14:07:47 -05:00
package-lock.json docs: Update to Docusaurs 3.6 to improve build times 2025-01-16 14:07:47 -05:00
package.json docs: Update to Docusaurs 3.6 to improve build times 2025-01-16 14:07:47 -05: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.