If you wish to contribute, submit a pull request with your changes. A wiki maintainer will review your contributions and merge them in if deemed appropriate.
Don't know where to start? Checkout this crash course on making contributions!
Alternatively, users who are unsure on how to work with Git can submit an issue that contains a link to a shared google document with the text you would like to contribute. Note this will take longer to process than submitting a pull request.
Translation efforts are managed using Crowdin. There you can see the status of each language available that needs translating.
Apply Here and make sure you are in the BSMG Discord. 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!
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
yarnto 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- If you run into an error when trying to use
yarn devon Windows, try taking outyarn.ps1andyarnpkg.ps1inuser/Appdata/Roaming/npm.
- If you run into an error when trying to use
- Open the link to
localhostthat 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.
The Wiki has a built-in linter that runs automatically when you push commits to enforce formatting rules. You can run this on your local copy with the command yarn lint to flag issues. You can also run yarn run lint:markdown --fix to have the linter try to resolve the issues automatically. If you need assistance with interpreting or fixing the errors, submit an issue with a screenshot of the errors attached.
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.
The wiki is deployed using Docker. Pull the latest image and run it. It exposes port 80, which can be remapped to whatever.
- The code that generates the wiki is licensed under the MIT License.
- The wiki content is licensed under the Creative Commons BY-NC-SA 4.0 License.
- Translations of the wiki content is owned by the Beat Saber Modding Group (BSMG) and licensed under the Creative Commons BY-NC-SA 4.0 License.