janheinrichmerker / website-iota-docs Goto Github PK

THE BACKBONE OF IOT IS HERE

Scalable, Decentralized, Modular, No Fees

This API docs were created with Slate. Check it out at github.com/lord/slate/.

You're going to need:

• Linux or OS X — Windows may work, but is unsupported.
• Ruby, version 2.2.5 or newer
• Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundler in a terminal.

You can change any color or size by modifying _variables.scss. As long as you don't change any unit everything should work as expected.

Basically everything is Github Flavored Markdown. You can find a more detailed documentation of what's possible here.

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

bundle install
bundle exec middleman server

You can now see the docs at http://localhost:4567. Whoa! That was fast!

1. Make sure your origin is a Slate fork in your own account, not the original repo.
2. Commit your changes to the markdown source: git commit -a -m "Update index.md"!
3. Push the markdown source changes to Github: git push
4. Run ./deploy.sh

Done! Your changes should now be live on http://yourusername.github.io/iota-docs, and the main branch should be updated with your edited markdown. Note that if this is your first time publishing Slate, it can sometimes take ten minutes or so before your content is available online.

See the original Slate documentation.

Read more about how to publish the docs to your own server in the original Slate documentation.