middleman-template's Introduction

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

Make sure you have Middleman installed:
```
gem install middleman
```
Then run:
```
middleman init PROJECT_NAME --template=thoughtbot/middleman-template
```
This will create a new Middleman app in a PROJECT_NAME directory.
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.
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

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.

middleman-template's People

Contributors

Stargazers

Watchers

middleman-template's Issues

SVG helper root

With the svg helper, we hard-coded the file path it looks at for the SVG’s. Can we leverage the set :images_dir configuration instead?

gem ffi 1.9.21 known issue building on ubuntu 16.04 and others

See here and here for reference.

the ffi gem which is somewhere in the dependency tree is broken at this version. I don't know which dependency tree it's in or how to find out, but the version of something which hopefully you guys control should probably be incremented.

Rename middleman-template?

Consistent with:

Turn into a Middleman Project Template

Netlify is a fantastic tool and suites us well for deploying Middleman app. The Netlify deploy button, though, is a bit confusing.

One big pain point I have is when you click the deploy button the readme, Netlify doesn't allow you to change the name of the repo its about the create. This is a problem for other thoughtbot developers because we obviously already have a repo in the thoughtbot org called middleman-template. I also believe it assumes it should use you personal GitHub account to fork the template, too, and that's often not what we want.

Middleman also offers a feature called Project Templates, which is a way to setup a GitHub repo to house a Middleman template. We can shuffle a few files around and instead utilize Middleman's Project Template feature instead of the Netlify deploy button to kick off a new project using our template. You can still easily deploy the project to Netlify once you're ready, you just won't start with Netlify. I think that's a fine trade-off. You usually don't need a deployed site the minute you create a new project.

thoughtbot / middleman-template Goto Github PK