eahefnawy/slate

Beautiful static documentation for your API

★ 0Forks 0JavaScriptGitHub ↗Compare

README

Yellow API Docs

Yellow API Docs are powered by Slate

Getting Set Up

  1. Make sure Ruby v1.9.3+ and bundler are installed. Install bundler with gem install bundler
  2. Clone this repo with git clone https://github.com/eahefnawy/slate.git
  3. cd slate
  4. Install all dependencies: bundle install
  5. Start the test server: bundle exec middleman server
  6. Make your edits in /source/index.md. As easy as that!

Deploying

  • Github Pages: Commit your changes, then run rake publish
  • Generate Static Files: Just run rake build, you'll find the generated files in the build directory

Contributors

lordchrissrogersbootstraponlineeahefnawyDaveAchkarkevin-buttercoinstyloadmyerscapablemonkeyjoelrmdlimastetzermoizjvsobstelRlordsamdozorswarzechfermayoxmo-odoozdenekdrahos

Issues