#Yoyo Wallet API Documentation

This document is to help explain how to get your local environment set up so you can edit the Yoyo Wallet API documentation.

Setup

git clone https://github.com/yoyowallet/slate
cd slate

If you do not already have a version of ruby running locally (not the OSX one), you need to follow these steps.

brew update
brew install rbenv ruby-build
echo 'eval "$(rbenv init -)"' >> ~/.bash_profile

Now install a version of Ruby >= 1.9.3 I chose the latest currently available:

rbenv install 2.2.3
rbenv global 2.2.3

gem install bundler

then

bundler install

If you get errors compiling native dependencies try this..

GCC_TREAT_WARNINGS_AS_ERRORS=NO gem install libv8 -v '3.16.14.7'
bundler install

Running the middleman server

bundle exec middleman server

Now go http://localhost:4567/ to view the documentation.

You can edit the source in /slate/source/index.md and the site will be regenerated automatically.

Creates a branch, without any parents (it's an orphan!)

git checkout --orphan gh-pages

Remove any content

git rm -rf .

Go back to master

git checkout master

git commit ...
git push

Then to actually publish

rake publish