We're using Slate to generate beautiful API docs.
To get started,
git clone [email protected]:ramen-dev/charturl-api-docs.git
cd charturl-api-docs
bundle install
You can run a local version of the docs site via the middleman server by running,
middleman server
And going to 0.0.0.0:4567
We're using Github pages to host the API docs.
Therefore to publish the docs you run,
rake publish
And changes will be published/deployed to docs.charturl.com