racker/kumoru-docs.github.io

Name: kumoru-docs.github.io

Owner: racker

Description: Kumoru Documentation

Created: 2015-12-16 17:00:18.0

Updated: 2016-12-16 19:09:04.0

Pushed: 2016-06-17 14:55:08.0

Homepage: null

Size: 140

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Kumoru.io Documentation

Welcome to the official Kumoru.io documentation (docs.kumoru.io) repo. The documentation is build using Slate.

The documentation is served via github pages off the branch gh-pages.

Preview

To build and preview the documentation, you can use the following docker command once you've cloned the repo.

cker run -d -p 4567:4567 --name slate -v $(pwd):/app/source -v $(pwd)/build:/app/build quay.io/kumoru/slate

The docs will be available at http://<DOCKERMACHINE_IP>:4567/

Building

To build and commit the docs, run bash build-html.sh. Note: you must have write privileges to this repo.

Contributing
  1. Clone the repo
  2. Edit the files in source/
  3. Submit a Pull Request

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.