/skaterxl-modding-documentation

🛠️🛹 A community managed documentation of useful information for modding SkaterXL, such as guides / starting steps, useful game functions / namespace layout, and more.

Primary LanguageRubyMIT LicenseMIT

Dev build test Netlify Status

🛠️🛹 SkaterXL Modding Documentation

DISCLAIMER: This is a community driven documentation and not official documentation of the game's code.

This repository holds the source for the SkaterXL Modding documentation github pages website.

This website is hosted on Netlify , using Jekyll for rendering & currently styled with the Just The Docs theme.

Contributing

In order to contribute, please push your changes onto the dev branch, and then open a pull-request to the master branch. This will allow actions to perform tests on the dev branch automatically before being able to complete the merge.

Building, serving & developing locally

In order to build and serve the website locally for development, follow the installation steps here, and then go to the cloned repository directory and run bundle exec jekyll serve and browse to http://localhost:4000 .

TBD:

  • Add some guides (transfer useful info / links from modding discord to be under the guides section)