Files
GeyserWebsite/README.md
T

45 lines
1.1 KiB
Markdown
Raw Normal View History

2021-12-12 14:21:41 +00:00
# GeyserMC Wiki
2021-12-12 14:09:40 +00:00
This is the repository that contains the wiki for all of GeyserMCs projects.
2021-12-12 14:09:40 +00:00
2021-12-12 14:21:41 +00:00
The wiki can be accessed using [this link](https://wiki.geysermc.org).
2021-12-12 14:09:40 +00:00
2021-12-12 14:21:41 +00:00
## Contributing
2021-12-12 14:09:40 +00:00
2022-02-20 12:51:51 +00:00
If you would like to contribute to the wiki, please [open a pull request](https://github.com/GeyserMC/GeyserWiki/pulls).
2021-12-12 14:09:40 +00:00
2021-12-12 14:21:41 +00:00
### Creating a new page
2021-12-12 14:09:40 +00:00
2021-12-12 14:21:41 +00:00
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
2021-12-12 14:09:40 +00:00
2021-12-12 14:21:41 +00:00
### Example page layout
2021-12-12 14:09:40 +00:00
2021-12-12 14:21:41 +00:00
```md
---
layout: page
title: Page title
permalink: /page/pagetitle/
---
2021-12-12 14:09:40 +00:00
2021-12-12 14:21:41 +00:00
# Page title
This is an example page
2021-12-12 14:09:40 +00:00
```
2021-12-12 14:21:41 +00:00
### Adding page to sidebar
2021-12-12 14:09:40 +00:00
2021-12-12 14:21:41 +00:00
Once you have added the file you can add an sidebar link, All sidebar links + sub links are in the _data/toc.yml file
2021-12-12 14:09:40 +00:00
2021-12-12 14:21:41 +00:00
### Example sidebar structure
2021-12-12 14:09:40 +00:00
```
2021-12-12 14:21:41 +00:00
- title: Page Title Documentation
url: "page/"
links:
- title: "Pagetitle sub link"
url: "page/pagetitle/"
children:
- title: PageChild sub link
url: "page/pagetitle/#headerLink"
2021-12-12 14:09:40 +00:00
```