Important

This project is no longer maintained. Thank you to everyone who contributed over the years.

Middleman Template

The base Middleman application used at thoughtbot, ready to deploy to Netlify.

Prerequisites

• Ruby 2.6.6 (confirm by running ruby --version)

Usage

1. Make sure you have Middleman installed:

   gem install middleman
   

2. Then run:

   middleman init PROJECT_NAME --template=thoughtbot/middleman-template
   

   This will create a new Middleman app in a PROJECT_NAME directory.

3. Move into the project directory, then start the Middleman server:

   bundle exec middleman server
   

   You should now be able to view the app at http://localhost:4567.

4. At this point, you have a fresh Middleman app on your local machine with an empty Git repository initialized. Your next steps might be:

   • Update README.md with your project specifics
   • Create a GitHub repository and add it as a remote
   • Create an initial Git commit and push it to GitHub
   • Setup CircleCI
   • Setup Hound
   • Setup deployment with Netlify

   Happy building!

Configuration

This template comes with the following features and tools:

• middleman-aria_current: An extension for indicating a current (active) link using aria-current.
• middleman-autoprefixer: Automatically vendor-prefix stylesheets.
• middleman-inline_svg: An extension for inlining SVGs in your views.
• middleman-minify-html: Minifies whitespace around HTML when the site is built.
• Sass: CSS pre-processor.
• Bourbon: Sass tool set.
• Bitters: Scaffold styles, variables and structure.
• normalize.css: Modern CSS "reset"
• Redcarpet: Markdown processing.
• CircleCI: Continuous integration.
• Hound: Comments on style violations in GitHub pull requests.
• stylelint: CSS and Sass linter.
• ESLint: JavaScript linter.

Contributing

See the contributing document. Thank you, contributors!

License

Copyright © 2018 Tyson Gach and thoughtbot, inc. This is free software, and may be redistributed under the terms specified in the LICENSE file.

About

This project is maintained and funded by thoughtbot, inc. The names and logos for thoughtbot are trademarks of thoughtbot, inc.

We love open source software! See our other projects or hire us to help build your product.