Do you want to add a plugin, expansion or software which doesn't have a documentation yet? Here's a small guide on how to add it.
Note that for simplicity reasons will we call plugins, expansions, etc. "resource" or "resources" throughout this page.
Before you start do we recommend to take a look at our Styling Guide to know all the details about what features we offer.
Each resource has its own folder under the
docs/wiki directory to allow them to have separate pages.
You can create as many pages for your resource as you want, as long as you keep it within the same folder (
To prevent any possible formatting issues will you need to follow these important rules:
- Only use alphanumerical characters in the folder and file names. If your resource/page uses spaces, replace them with dashes (
-). Do not use underscores (
For example turns
- Names of folders and files have to be all lowercase.
- It's recommendet to create a
index.mdfile which would be displayed first when connecting to the sub-page of the resource (
- Any images you want to use need to be in their own folder under the
docs/assets/img/wikidirectory. The name of the folder should match the one of the
Adding pages to the mkdocs.yml¶
Now that you've created your files is it time to actually add them to the
mkdocs.yml file, to tell MkDocs, where you can find those pages.
mkdocs.yml will you find a section called
nav which acts as the navigation/list of MkDocs.
To add your files, you first need to create a sub-directory under the
nav: - Welcome: index.md - Contribute: - Contribute: contributing/index.md - Styling: contributing/styling-guide.md - Wiki: - Welcome: wiki/index.md # Imagine here to be any other resources - Your Resource:
We would appreciate it, if you could keep it ordered by alphabet (0-9 first, followed by A-Z).
Welcome will always be the top entry in the nav however.
Now that you have added it, is it time to add your pages.
You can add them either by just providing the relative path (
- 'wiki/<your-resource>/<page>.md') or by prefixing it with a name that would be displayed in the navigation on the left (
- The Page: wiki/<your-resource>/<page>.md).
It's recommendet to name the pages, as you can use spaces and non-alphanummerical characters in it (Although last one isn't recommendet as it probably won't render well).
If you've done everything should the nav section look something similar to this:
nav: - Welcome: index.md - Contribute: - Contribute: contributing/index.md - Styling: contributing/styling-guide.md - Wiki: - Welcome: wiki/index.md # Imagine here to be any other resources - Your Resource: - Hello: wiki/your-plugin/index.md - About: wiki/your-plugin/about.md
Create a Pull Request¶
You can now create a Pull Request towards the Wiki-Docs repository to get it added (if everything is alright).
Here are some styling suggestions for the files to keep them organized and simple
It's highly recommendet to use a reference link in your file.
Reference links are links prefixed by a text within square brackets. (Example:
These kind of links have some benefits:
- You only need to update a single instance of the URL and don't have to go through each one separately.
- You just need to provide
[text]and Markdown will translate it to
textcontaining the link.
- You can keep the links at a single place (i.e. on top of the page) for easier managing and updating.
You can upload images to the repository, by creating a folder named after the resource under the
After you've uploaded your images can you reference them like this:
Please make sure to upload the images as either
.jpg to save resources and storage space.
You're allowed to use external sites for the images and use the respective URLs for them, but keep in mind that we might deny your PR if it uses a sketchy website for images.
Below can you find a list of trusted sites for uploading and sharing images and gifs.
Note that this is by no means a complete list and that it might get updated from time to time.
MkDocs (And especially the Material Theme) allows us to directly implement Videos from sources like YouTube, which isn't possible for pages like GitHub Wikis.
In order to display a video will you need to use the
<iframe> option which most video-sites should provide.
This is an example using the video "How to use SlimeWorldManager" found on YouTube.
<iframe width="560" height="315" src="https://www.youtube.com/embed/FIA-oy-fx7A" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>