search

cloudant-labs / slate

The Cloudant Documentation, built with Slate
Other
14 stars 17 forks source link

readme

docs.cloudant.com

Build Status

The Cloudant documentation, built using slate. Check it out here.

For more info on how the documentation works, see the Slate wiki.

Install

If you want to work on the docs locally, install Ruby and bundler, then do this:

git clone git@github.com:cloudant-labs/slate.git
cd slate
bundle install
bundle exec middleman server

Alternatively, you can use Vagrant and Virtualbox to set up a development environment. Once Vagrant and Virtualbox have been installed, run

git clone git@github.com:cloudant-labs/slate.git
cd slate
sudo vagrant up

In both cases, your docs site will be reachable at http://localhost:4567/.

Note that the search bar will not work locally because it uses Cloudant's search handler.

Contribute

The Cloudant documentation is updated whenever the master branch of this repository sees a new commit, thanks to Travis and CouchApp. So, to contribute changes to the docs, just make a pull request! You can find all the copy in the intro or in the includes directory.

For more details on what we expect from contributions, see CONTRIBUTING.MD.

Happy hacking!

License

MIT, yo.