Skip to content

Ctrlpanel-gg/docs

Repository files navigation

Ctrlpanel.gg Docs

This website is built using Docusaurus 2, a modern static website generator.

Contributing

Follow these steps when contributing to this repository:
1: Fork this repository
2: Make your changes
3: Open a PR from your fork to the development branch
4: Wait for the workflow to verify your modification can build with success

Local Installation

This command will install dependencies.

yarn install

Local Development

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

yarn start

Deployment

This is automated, every push to the main branch into the /docs directory will trigger the deployment workflow and host the side via GitHub pages.
You can also deploy it manualy by clicking Run workflow here.