API documentation for mod.io - a modding platform for game developers
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
lib
source
.gitignore Updated gitignore May 22, 2018
.travis.yml
CHANGELOG.md Add a few more release notes Jul 17, 2017
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Jul 17, 2017
Gemfile
Gemfile.lock Updated gem dependencies. Jan 29, 2019
LICENSE Update copyright year Oct 11, 2013
README.md
Vagrantfile Update Vagrant to Ruby 2.4 (#803) Jun 29, 2017
config.rb Adds unique header creation (#743) Apr 6, 2017
deploy.sh
font-selection.json Remove unused icons from the font May 31, 2015

README.md

mod.io

API Documentation

License Discord Master docs

Documentation for mod.io is powered by slate, a static API generator and can be read here (also see our getting started guide). We use swagger.io to define our API from comments in our codebase, and generate the slate markdown files from it using widdershins.

Output

We recommend you don't edit source/index.html.md as this file is generated automatically via the above process. You can edit the presentation and source/includes/_modio.md as these are manually created.

Setup

To get our slate documentation up and running on your local machine, we recommend you follow the instructions on the official slate repository page.

Contributions Welcome

Want to correct errors in our documentation or it's layout? Submit a pull request with your recommended changes to be reviewed.

Other Repositories

Our aim with mod.io, is to provide an open modding API. You are welcome to view, fork and contribute to our other codebases in use: