/electrode-io.github.io

Documentation site for the newly open sourced Electrode Platform

Primary LanguageCSSOtherNOASSERTION

electrode-io.github.io

This repository contains the source for the Electrode documentation site, which is generated using Jekyll.

Contributing

  • Commit contributions to the develop branch.
  • Always use markdown when authoring new documentation.

Installation

Pre-requisites

Requires jekyll and bundler. You can install them with gem:

$ gem install jekyll bundler

Setup & Run

First, clone the repository and install the project dependencies using bundler:

$ git clone https://github.com/electrode-io/electrode-io.github.io.git  
$ cd electrode-io.github.io  
$ bundle install

Run the server locally:

$ bundle exec jekyll serve

You should be able to access the site at: http://127.0.0.1:4000/

Deploying to GitHub Pages

The site must be generated locally and deployed using jgd.

NOTE: this should be done from a local clone of the original repo; make sure you're not working in a fork.

First, make sure the jgd gem is installed by running bundle install. Next, generate and deploy to master with the following command:

$ jgd --branch=master

Explore the Electrode.io Website.

Built with ❤️ by Team Electrode @WalmartLabs.