Mirrors/webamp
1
0
Fork 0
mirror of https://github.com/captbaritone/webamp.git synced 2026-01-23 10:15:31 +00:00
Code Issues Projects Releases Wiki Activity
webamp/packages/webamp-docs
History
Jordan Eldredge e52900d4fc Add Milkdrop to docs example
2025-07-04 19:44:47 -07:00
..
blog Add docs site 2025-06-18 23:43:23 -07:00
docs Move butterchurn loader docs to bundle size guide 2025-07-04 19:10:02 -07:00
src Add Milkdrop to docs example 2025-07-04 19:44:47 -07:00
static Docs improvements 2025-06-22 20:32:36 -07:00
.gitignore Add docs site 2025-06-18 23:43:23 -07:00
docusaurus.config.ts Set new docs domain 2025-06-19 00:17:59 -07:00
package.json Add docs site 2025-06-18 23:43:23 -07:00
README.md Add docs site 2025-06-18 23:43:23 -07:00
sidebars.ts Add docs site 2025-06-18 23:43:23 -07:00
tsconfig.json Add docs site 2025-06-18 23:43:23 -07:00

README.md

Website

This website is built using Docusaurus, 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.