We use the Slate framework for exporting API docs https://github.com/slatedocs/slate
https://github.com/slatedocs/slate/wiki/Using-Slate-Natively
On Mac it's best to install Ruby via Homebrew
brew install ruby
echo 'export PATH="/usr/local/opt/ruby/bin:$PATH"' >> ~/.bash_profile
source ~/.bash_profile
Install Middleman
bundle install
Only need to do this if you want it to update in the background while you edit
bundle exec middleman server
- Edit any content in
source/index.md
- Publish static version of docs
bundle exec middleman build --clean
- Copy to API repo
Copy any changed files from the "build" dir into thepublic_html
dir in thespeedcurve-api
repo