christoff-1992/Oxide.Docs

API documentation for the Oxide mod framework.

Oxide Docs

Contributing

Prerequisites

You're going to need:

• Ruby, version 1.9.3 or newer
• Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundler in a terminal.

Setup

1. Fork this repository on GitHub.
2. Clone your forked repository (not our original one) git clone https://github.com/YOURUSERNAME/Oxide.Docs.git
3. Open up the Ruby command console.
4. Type cd Oxide.Docs in the Ruby console.
5. Install all dependencies: bundle install
6. Start the test server: bundle exec middleman server

You can now see the docs at http://localhost:4567. Whoa! That was fast!

Now that you have it all setup, you'll probably want to learn more about editing markdown.

Once you've made the changes you'd feel are needed, push them to your fork and then submit a pull request. Simple as that!

Special Thanks

• Robert Lord, creator of Slate, and contributors
• Middleman - for making everything a sinch
• jquery.tocify.js - for helping make pretty things
• Font Awesome - because you're simply awesome