multi-scrobbler/docsite
FoxxMD 5e0c4e3e77 docs(vlc): Some fixes for VLC docs
tags <> in code block in details causes parsing error
2024-08-23 09:00:14 -04:00
..
docs docs(vlc): Some fixes for VLC docs 2024-08-23 09:00:14 -04:00
src docs(vlc): Add VLC docs 2024-08-22 17:30:37 -04:00
static docs: Update docusaurs playground schema for MS to latest 2024-07-09 15:55:07 -04:00
.gitignore feat: Implement somewhat-working docusaurus site 2023-07-13 15:08:00 -04:00
babel.config.js feat: Implement somewhat-working docusaurus site 2023-07-13 15:08:00 -04:00
docusaurus.config.ts docs: Add quick start guide 2024-07-17 11:33:56 -04:00
package-lock.json docs: Add quick start guide 2024-07-17 11:33:56 -04:00
package.json docs: Add quick start guide 2024-07-17 11:33:56 -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 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.