huboard/huboard-enterprise-docs

Name: huboard-enterprise-docs

Owner: HuBoard

Description: Documentation for HuBoard Enterprise

Created: 2015-11-10 01:35:42.0

Updated: 2016-03-30 02:35:24.0

Pushed: 2016-09-22 03:49:27.0

Homepage: null

Size: 3313

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Proteus - Jekyll

About Proteus

Proteus is a collection of useful starter kits to help you prototype faster. It follows the thoughtbot styleguide and includes our favorite front end tools.

About Jekyll

Jekyll is a static site generator built in Ruby. This makes it a great fit for projects that may end up as a Ruby on Rails app.

Includes

We also recommend Refills for prepackaged interface patterns.

Getting Started

Set up your project in your code directory

clone https://github.com/thoughtbot/proteus-jekyll.git your-project-folder
our-project-folder
remote rm origin
remote add origin your-repo-url

Install dependencies

le install

Run the server and watch for changes in your files

ll serve -w

Deploy to Github Pages

ll build && git subtree push --prefix build origin gh-pages

Or install the Proteus gem and enjoy some shortcuts.

Stylesheets, fonts, images, and javascript files go in the /source/_assets/ directory. Vendor stylesheets and javascripts should go in each of their /vendor/ directories.

Issues

If you have problems, please create a GitHub Issue.

Contributing

Have a fix or want to add a feature? Pull Requests are welcome!

Credits

thoughtbot

Proteus Jekyll is maintained and funded by thoughtbot, inc. Thank you to all of the contributors!

License

Copyright © 2014?2015 thoughtbot, inc. Proteus Jekyll is free software, and may be redistributed under the terms specified in the license.


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.