Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nuckerr/kitpvpplus-docs

Documentation for KitPvPPlus
https://github.com/nuckerr/kitpvpplus-docs

Last synced: about 1 month ago
JSON representation

Documentation for KitPvPPlus

Awesome Lists containing this project

README

        

**The main repo for KitPvP Plus can be found [here](https://github.com/Nuckerr/KitPvPPlus). This repo only contains the documentation files. To view the actual plugin code please that repo.**

# KitPvPPlus-docs
KitPvP Plus is a customizable KitPvP core for 1.8 - 1.17. This is the documentation of how to use it. It covers configs, commands and more! This repo also includes the javadocs
for the plugin api.

## Links:
- [Wiki](https://wiki.nucker.me)
- [Javadocs](https://wiki.nucker.me/javadocs/)

## Contributing
The main reason of this repo is to allow anyone to edit and improve the documentation. If you think something is missing, you can create/edit an md file in the `articles/` folder. Once your
happy with the edits, make a pull-request with it and someone on the development team will review it, build it and push it!

Use markdown formatting as well as formating from mkdocs & mkdocs for material.

### Formating docs:
- [Mkdocs](https://www.mkdocs.org/user-guide/writing-your-docs/)
- [Material for mkdocs](https://squidfunk.github.io/mkdocs-material/reference/)

*Any changes to the `site/` folder will be denied. This folder contains the build outputs and any manual changes **will be** overridden upon build.*

## Credits
Massive thank you to [realdeadbeef](https://github.com/realdeadbeef) for helping set this up as well as write a large amount of it.

Thank you to all the [contributers](https://github.com/Nuckerr/KitPvPPlus-docs/graphs/contributors) who have helped make/write this documentation.

---
*Wiki hosted in Cloudflare Pages & Javadocs hosted with Github Pages.*