Slate helps you create beautiful, intelligent, responsive API documentation.

The example above was created with Slate. Check it out at lord.github.io/slate.

Getting Started with Slate

Prerequisites

You're going to need:

• Linux or macOS — Windows may work, but is unsupported.
• Ruby, version 3.1.0p or newer
• Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundler in a terminal.

If you are on an M1 machine, you may experience problems installing ruby, please following this guide here https://www.moncefbelyamani.com/how-to-install-xcode-homebrew-git-rvm-ruby-on-mac/?utm_source=stackoverflow&utm_campaign=51126403

Developing Locally

1. Clone this repo at https://github.com/procurify/sticky.git
2. cd slate
3. 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.

Deploying to Github Pages

A deploy script comes bundled with the repo, just follow these steps here in the official wiki to deploy to https://procurify.github.io/sticky/#netsuite.