diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..13f7a49 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# 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 pages 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 +--- +title: Page title +page_sidebar: false (optional) +--- + +# Page title +This is an example page. +``` + +### Adding page to the sidebar + +Once you have added the file you can add a 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" +``` + +### GeyserWiki development - Local deployment on Windows. + +* Download and install Ruby using the Ruby+Devkit from https://rubyinstaller.org/downloads/. + +* Once installed, run 'ridk install' in console to open the RubyInstaller. +For this usecase, it is recommended to choose the third option, "MSYS and MINGW". After that, the Ruby installation is completed. + +* Open the GeyserWiki folder in VScode. There, open a terminal to install the bundle using the 'bundle install' command. +Installing it for the first time can take a while. + +* Once installed, you can start the webserver locally with the 'bundle exec jekyll serve' command in the VSC terminal. diff --git a/README.md b/README.md index 65a79cd..5d72d42 100644 --- a/README.md +++ b/README.md @@ -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). \ No newline at end of file