Add development environment setup in the CONTIBUTE markdown and move the readme info (#167)

* Add development environment setup in the readme

* Add CONTRIBUTING.md and move the info from readme.

* remove contubuting info

* rewording

* md layout got changed

* use () instead of "" for optional
This commit is contained in:
Jens Collaert authored and GitHub committed 2023-11-02 08:29:42 +01:00
1 parent 87cdee066d
commit ea1c8c7e6b
2 files changed
+51 -41

No files matched your search

+1 -41
View File
@@ -2,44 +2,4 @@
This is the repository that contains the wiki for all of GeyserMCs projects.
The wiki can be accessed using [this link](https://wiki.geysermc.org).
## Contributing
If you would like to contribute to the wiki, please [open a pull request](https://github.com/GeyserMC/GeyserWiki/pulls).
### Creating a new page
Most documentation is in the docs folder where you can add new page's or edit the current ones.
If a new page is being added make sure you add its page properties at the beginning of the file.
Make sure that the file extension is .md in this case pagetitle.md
### Example page layout
```md
---
layout: page
title: Page title
permalink: /page/pagetitle/
---
# Page title
This is an example page
```
### Adding page to sidebar
Once you have added the file you can add an sidebar link, All sidebar links + sub links are in the _data/toc.yml file
### Example sidebar structure
```
- title: Page Title Documentation
url: "page/"
links:
- title: "Pagetitle sub link"
url: "page/pagetitle/"
children:
- title: PageChild sub link
url: "page/pagetitle/#headerLink"
```
The wiki can be accessed using [this link](https://wiki.geysermc.org).