PGM XML Documentation
Documentation for the XML format PGM uses to define map specific features.
Pages are hosted using github pages.
Editing Notes
- Pages are formated in markdown and may contain HTML, HTML should only be used where absolutely needed.
- Markdown is parsed with kramdown which has an enhanced syntax.
- Care should be taken when removing trailing whitespace since markdown uses two spaces to create a newline.
Pull Requests
Pull requests should have the following things:
-
The commits should have a descriptive message and which is not in the past tense.
For example:
Describe the XYZ module with more detail.
or Add detailed description for XYZ.
is good, but: Added XYZ.
isn't.
-
Content should be grammatically correct and the spelling should be US English, e.g. Color not Colour.
Previewing your changes
- Install ruby (Mac, Windows, Ubuntu) (we don't need rails, so just install ruby)
- Install the bundler gem.
- Run
bundle install
from the source root.
- Run
bundle exec jekyll serve
or jekyll serve
- Load
localhost:4000
in your browser.