https://github.com/thoughtbot/proteus-middleman
[no longer maintained]
https://github.com/thoughtbot/proteus-middleman
Last synced: 24 days ago
JSON representation
[no longer maintained]
- Host: GitHub
- URL: https://github.com/thoughtbot/proteus-middleman
- Owner: thoughtbot
- Archived: true
- Created: 2014-10-17T04:06:52.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2017-12-13T22:34:28.000Z (over 8 years ago)
- Last Synced: 2024-05-09T08:00:51.601Z (about 2 years ago)
- Language: CSS
- Homepage:
- Size: 74.2 KB
- Stars: 133
- Watchers: 44
- Forks: 25
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# thoughtbot Middleman Starter
**Note:** This project is no longer being actively maintained. Check out our
[Middleman Template], instead.
[Middleman Template]: https://github.com/thoughtbot/middleman-template
## About
This starter kit for Middleman follows the
[thoughtbot styleguide](https://github.com/thoughtbot/guides) and includes our
favorite front end tools.
## About Middleman
Middleman 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. Its minimalistic structure
makes it very easy to work with, and includes support for deploying to Github
Pages.
## Includes
* [HAML](http://haml.info):
Simple template markup
* [Coffeescript](http://coffeescript.org):
Write javascript with simpler syntax
* [Sass (LibSass)](http://sass-lang.com):
CSS with superpowers
* [Bourbon](http://bourbon.io):
Sass mixin library
* [Neat](http://neat.bourbon.io):
Semantic grid for Sass and Bourbon
* [Bitters](http://bitters.bourbon.io):
Scaffold styles, variables and structure for Bourbon projects.
* [Middleman Live Reload](https://github.com/middleman/middleman-livereload):
Reloads the page when files change
* [Middleman Deploy](https://github.com/karlfreeman/middleman-deploy):
Deploy your Middleman build via rsync, ftp, sftp, or git (deploys to Github Pages by default)
We also recommend [Refills](http://refills.bourbon.io/) for prepackaged interface patterns and [Proteus](http://github.com/thoughtbot/proteus) for a collection of useful
starter kits to help you prototype faster.
## Getting Started
Set up your project in your code directory
```
git clone https://github.com/thoughtbot/proteus-middleman.git your-project-folder
cd your-project-folder
git remote rm origin
git remote add origin your-git-url
```
Install dependencies:
```
bundle install
```
Run the server
```
bundle exec middleman
```
Deploy to Github Pages
```
bundle exec middleman deploy
```
Or install the [Proteus gem](https://github.com/thoughtbot/proteus) and enjoy some shortcuts.
## Directories
Stylesheets, fonts, images, and JavaScript files go in the `/source/assets/` directory.
Vendor stylesheets and JavaScripts should go in each of their `/vendor/` directories.
## Contributing
If you have problems, please create a
[GitHub Issue](https://github.com/thoughtbot/proteus-middleman/issues).
Have a fix or want to add a feature?
[Pull Requests](https://github.com/thoughtbot/proteus-middleman/pulls) are welcome!
## Credits
[](http://thoughtbot.com)
thoughtbot Middleman Starter is maintained and funded by [thoughtbot, inc](http://thoughtbot.com). Thank you to all of [the contributors](https://github.com/thoughtbot/proteus-middleman/contributors)!
## License
Copyright © 2014–2015 [thoughtbot, inc](http://thoughtbot.com). thoughtbot Middleman Starter is free software, and may be redistributed under the terms specified in the [license](https://github.com/thoughtbot/bourbon/blob/master/LICENSE.md).