Skip to content

Teamtailor/tt-partner-docs

Folders and files

NameName
Last commit message
Last commit date
Nov 5, 2021
Feb 21, 2025
Aug 28, 2018
Oct 1, 2021
Aug 28, 2018
Aug 28, 2018
Feb 12, 2025
Oct 1, 2021
Oct 1, 2021
Aug 28, 2018
Jan 3, 2024
Oct 7, 2021
Oct 5, 2021
Aug 28, 2018
Feb 12, 2025
Aug 28, 2018

Repository files navigation

Slate: API Documentation Generator
Build Status

Live version - HERE
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:
# 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, or how to publish your docs.

If you'd prefer to use Docker, instructions are available in the wiki.