Giter VIP home page Giter VIP logo

chipdocs's Introduction

Next Thing C.H.I.P. Documentation

All documentation is written in markdown and staged on github pages. Published documentation is viewable on the github pages or getchip site.

If you want to add or modify a document, add your markdown file to the includes directory and make a pull request. You can use Github markdown or regular markdown.

Each include represents a top-level topic in the left-hand navigation if it is in the list of includes in index.html.

Note: If you view the files in the include/ directory here on github, the image links appear broken. This is to be expected because these pages have yet to be rendered into a viewable state.

Uses the Slate Documentation Generator

This repo is forked from Slate. Read the docs on the original Slate repo wiki if you want all the details. There are also some sample docs worth perusing.

Here's the crux of the matter, though:

Prerequisites

You're going to need:

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

Publish

If you are a contributor, it is easy to publish any changes you make. First, push your local changes to the master branch, then, in a terminal cd to your local repo and use the command rake publish. This will render static html pages, and push the changes to the gh-pages branch of this repo, making them live at http://docs.getchip.com

chipdocs's People

Contributors

lord avatar lividinstruments avatar chrissrogers avatar realityking avatar cvkef avatar bootstraponline avatar maks3w avatar djpowers avatar victorquinn avatar rezanachmad avatar kevin-buttercoin avatar davidmurdoch avatar aagallag avatar mattes avatar moizjv avatar niksamokhvalov avatar floorlamp avatar encukou avatar pbechu avatar sobstel avatar rlord avatar swarzech avatar manacake avatar fermayo avatar niftylettuce avatar telarium avatar xmo-odoo avatar xunzhang avatar zdenekdrahos avatar styloa avatar

Watchers

André Márcio de Lima Curvello avatar James Cloos avatar

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.