This project houses source code/examples for the SWEEP Platform documentation. More detailed documentation at https://docs.sweep.run/.
Following commands assume MacOS (please feel free to submit a pull-request for Windows)
Please make sure to install Ruby at https://rubyinstaller.org/
$ git clone ...SWEEP-DOCS
$ cd SWEEP-DOCS
$ bundle install
$ bundle exec middleman server
Brings up the static website at http://localhost:4567.
If 'bundle' does not exist, use 'Homebrew' to install
Windows: In your Gemfile, you must add
gem 'middleman-gh-pages'
and then use
$ bundle install
again.
Create Rakefile, and add the below text to it
require 'middleman-gh-pages'
task :default => [:build]
To build the site i.e. index.html, CSS etc. do
$ rake build
The above command puts the contents of the site in the 'build' directory, next step is to make the static files under the 'gh-pages' branch. Goal is that we want the site to be hosted using GitHub.
$ cd build
$ git checkout -b gh-pages
$ rake publish
The content is pushed to gh-pages branch, which is then linked to the custom domain More here.
Examples and more documentation?
Go to https://docs.sweep.run/ for API, and detailed documentation
API documentation template
Check out Slate.
Apply to SWEEP Beta Platform
Apply here for access SWEEP beta platform.
Feel free to submit pull requests with examples, and additional clarifications.
Submit an issue to the SWEEP documentation repo if you need any help.
https://www.sitepoint.com/writing-api-documentation-slate/ http://altrepo.eu/Myridia/slate/blob/965156d54b10dced25716e36f304203aff8a22dc/Rakefile