📖 BSMG Wiki

✏️ Contributing

If you wish to contribute, submit a pull request with your changes. A wiki maintainer will review your changes and merge them in if deemed appropriate.

Don't know where to start? Checkout this crash course on making contributions!

🌐 Localization

Translation efforts are managed using Crowdin. There you can see the status of each language available that needs translating. Want to help out? Apply Here and we will be in touch!

If you don't see your language available on Crowdin you can still apply and we will add it once you are accepted!

🧪 Development

To run a local copy of the wiki:

Install Node.js
Install Yarn
Fork this repo, then clone it. Make sure to do all work on another branch.
Open a command-line window in the directory you just cloned into, then run the command yarn to install required packages.
After packages are installed, start the development server with the command yarn dev. You can kill the server by closing the terminal or by pressing CTRL+C
Open the link to localhost that appears in the console once the development server is running.

When you make changes to your local wiki files, the local website will update those pages as soon as they are saved! Note: Sidebar headers do not change due to an issue with Vuepress. They will render correctly if you restart the dev server, and on the final build.

Once you have finished making changes, you can either commit them directly using git tools, or copy them into the GitHub web interface if you don't know how to use git.

🚀 Deploying

The wiki is deployed using Docker. Pull the latest image and run it. It exposes port 80, which can be remapped to whatever.

🔐 Licensing