Code Monkey home page Code Monkey logo

docs's Introduction

Iron.io Dev Center Documentation

The Dev Center docs are a Jekyll project. Refer to Jekyll's official docs and Using Jekyll with GitHub Pages for complete help. We give a quick start guide below.

Installation

  1. Get Bundler, the Ruby dependency manager, if you don't have it already.
  2. $ git clone https://github.com/iron-io/docs.git && cd docs
  3. $ bundle install

Launching

  1. In the project directory, run bundle exec jekyll serve
  2. Open your browser to http://localhost:4000/

Contributing

In the project directory, run bundle exec jekyll serve --watch. This will auto-reload as you make changes to files. TODO: not sure if --watch is required anymore?

Please submit all changes as Pull Requests.

Try not to use HTML unless it's required! Use markdown for everything if possible.

Using Docker to avoid the pain of installing things like nokogiri

  1. docker build -t jekyll .
  2. docker run --rm -it -v "$PWD":/app -p 4000:4000 jekyll serve --watch --host 0.0.0.0

Note: to do a bundle update, run docker run --rm -it -v "$PWD":/app -w /app iron/ruby:dev bundle update

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.