Slate: API Documentation Generator
Build Status

Live version - [HERE](https://partner.teamtailor.com/)
Hosted on Netlify by auto push master branch Getting Started with Slate ------------------------------ ### Prerequisites You're going to need: - **Linux or OS X** — Windows may work, but is unsupported. - **Ruby, version 2.0 or newer** (If got problem instaling ruby 2.6.5 run RUBY_CFLAGS="-Wno-error=implicit-function-declaration" rbenv install 2.6.5) - **Bundler** — If Ruby is already installed, but the `bundle` command doesn't work, just run `gem install bundler` in a terminal. ### Getting Set Up 1. Fork this repository on Github. 2. Clone *your forked repository* (not our original one) to your hard drive with `git clone https://github.com/YOURUSERNAME/slate.git` 3. `cd slate` 4. Initialize and start Slate. You can either do this locally, or with Vagrant: ```shell # either run this to run locally bundle install bundle exec middleman server # OR run this to run with vagrant vagrant up ``` You can now see the docs at http://localhost:4567. Whoa! That was fast! Now that Slate is all set up on your machine, you'll probably want to learn more about [editing Slate markdown](https://github.com/lord/slate/wiki/Markdown-Syntax), or [how to publish your docs](https://github.com/lord/slate/wiki/Deploying-Slate). If you'd prefer to use Docker, instructions are available [in the wiki](https://github.com/lord/slate/wiki/Docker).