tylor512 / steemit-docs Goto Github PK

Welcome to the steemit API and Developer Docs.

The Live Steem API Developer docs can be viewed at steemit API docs

Steemit is the social media platform where everyone gets paid for creating and curating content.

The following API documents provide details on how to interact with the Steem blockchain database API which can get information on accounts, content, blocks and much more!

The developer portal will also serve as a toolbox for steem clients, libraries, and language wrappers.

Steemit docs are built with the great slate framework. Slate supports markdown for editing our API documentation.

1. Clone this repository to your hard drive with git clone https://github.com/steemit/steemit-docs.git
2. cd steemit-docs
3. Initialize and start Slate. You can either do this locally, or with Vagrant:

# either run this to run locally
bundle install
bundle exec middleman server

# OR run this to run with vagrant
vagrant up

4. The docs should now be viewable at http://localhost:4567/

1. Commit your changes locally
2. Make sure your origin remote is set to https://github.com/steemit/steemit-docs
3. Git push origin master
4. Run ./deploy.sh