PGM Documentation Website

Source for the official PGM plugin documentation, using Docusaurus 2.

Overview

This website aims to be a direct successor to the old XML Documentation website, and much of its content will be inherited. However, since PGM has now been open-sourced, this new website aims to widen the scope and introduce more materials, ranging from map & XML documentation, to PGM's features, to development processes for contributing features to PGM. As such, this website is designed not only for individual server administrators and map developers, but also for contributors to the PGM project and its community at large.

Usage

Follow the steps below to get a working local installation of this documentation website.

Run npm install in this project's root folder. This will install all dependencies.
Once it's done, run npm start. This command starts a local development server and opens up a browser window. Most changes are reflected live without needing to restart the server.
Depending where you host it, you can build the website using npm build if you intend to upload it yourself, or build it and deploy it to Github pages using GIT_USER=<Your GitHub username> USE_SSH=true npm deploy. The later is a convenient way to build the website and push to the gh-pages branch.

How to Contribute

Before opening a Pull Request, please:

Verify that there is no ongoing discussion concerning the implementation you wish to contribute. You can search for such a discussion in the plugin's repository issues page.
Make sure your contribution follows American (US) English grammar rules and spelling, e.g. "color" and not "colour".

Governance

This project is maintained by Indicado, with assistance from Electroid and other members from the PGM community.

License