Skip to content

๐Ÿ”ง Setup

Setup๐Ÿ”—

Quick Edits๐Ÿ”—

Quick changes can be made by clicking the pencil icon at the top of each page. This lets you edit the docs directly in your browser. The Guidelines still apply!

All the files are markdown files. Markdown is the stuff you partially know from discord text highlighting.

**Bold text** result
_Italic text_ result

Advanced Edits๐Ÿ”—

More advanced edits can be done with IntelliJ or any other IDEA. This guide will show the process with it and includes some neat tricks that are exclusive to IntelliJ.

  • Clone in IntelliJ and select the "Docs" project scope.

  • Create a new branch before you start editing anything.

Make sure Python3 is installed on your local system. If you use Python for more than this you might want to look into python virtual environments to avoid conflicts. This should not be the case for any non-devs though.

You may need to install GTK if you are on Windows. Install all other dependencies by entering pip install -r config/docs-requirements.txt in the console.

In case you are a material-mkdocs insider (paid premium version): Set your license key by executing set MKDOCS_MATERIAL_INSIDERS=LICENSE_KEY_HERE (Windows) in the console. Then run pip install -r config/docs-requirements-insiders.txt instead of docs-requirements.txt.

The only thing thats missing once you have done all that is all large files (images & videos). We use Git LFS to store them, so you need to install that too. Just run git lfs install once you have executed the file that you downloaded from the Git LFS website.
Then use git lfs pull to actually download the files.

Congrats! You should be ready to go.

See your changes live๐Ÿ”—

You are now primarily working with tools called mkdocs and mkdocs-material-theme in case you want to google anything. All files are regular markdown files though.

MkDocs enables you to create a website that shows you your changes while you make them. Execute this to see a preview of the webpage on 127.0.0.1:8000:

mkdocs serve

Last update:
Back to top