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
- HAML: Simple template markup
- Coffeescript: Write javascript with simpler syntax
- Sass: CSS with superpowers
- Autoprefixer: Add vendor prefixes to CSS
- Bourbon: Sass mixin library
- Neat: Semantic grid for Sass and Bourbon
- Bitters: Scaffold styles, variables and structure for Bourbon projects.
We also recommend Refills for prepackaged interface patterns.
Getting Started
Set up your project in your code directory
git clone https://github.com/thoughtbot/proteus-jekyll.git your-project-folder
cd your-project-folder
git remote rm origin
git remote add origin your-repo-url
Install dependencies
bundle install
Run the server and watch for changes in your files
jekyll serve -w
Deploy to Github Pages
jekyll 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
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.