Skip to content
Accelo API Documentation
JavaScript CSS Ruby Shell HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib Fix ToC issues, fix #995 Jul 5, 2018
source
.gitignore
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
Gemfile
Gemfile.lock
LICENSE
README.md
Vagrantfile
config.rb Allow strikethrough with two tildes in markdown, fixes #929 Jan 19, 2018
deploy.sh Rename OS X to macOS in deploy.sh comment (#951) Feb 5, 2018
font-selection.json

README.md

Accelo API Documentation

Powering the documentation at api.accelo.com/docs/

Getting Started

Prerequisites

You're going to need:

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

Running Preview

# 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.

Note on JavaScript Runtime

For those who don't have JavaScript runtime or are experiencing JavaScript runtime issues with ExecJS, it is recommended to add the rubyracer gem to your gemfile and run bundle again.

Need help?

To report problems or ask questions please post to our development forum and someone will be happy to help 😃

If you see issues or would like to make an improvement in the documentation please don't hesitate to contribute with a pull request.

Special Thanks

  • A big thanks to all the contributors and maintainers of Slate ❤️ ; and
  • Even bigger thanks to Matthew H - the primary author of these docs! 🎉

Maintenance

Upgrading Slate

To upgrade slate, please merge the upstream master into a new branch off of master. As this process may result in conflicts and breaking changes, it should go through the usual pull request process before being deployed on master.

git checkout master
git checkout -b slate-upgrade
git fetch upstream
git merge upstream/master
You can’t perform that action at this time.