Hand-crafted frontend development

Find a file

Moritz Breit b234deb540 Add cucumber scenarios for markdown pages with erb layout These are tests for middleman/middleman#860.		2013-06-12 11:23:00 -07:00
middleman	Force padrino to skip safebuffer on erb	2013-06-08 15:36:14 -07:00
middleman-core	Add cucumber scenarios for markdown pages with erb layout	2013-06-12 11:23:00 -07:00
middleman-more	Add cucumber scenarios for markdown pages with erb layout	2013-06-12 11:23:00 -07:00
.gitignore	Force padrino to skip safebuffer on erb	2013-06-08 15:36:14 -07:00
.gitmodules	merge more into core, use gem availability to autoload	2013-05-09 14:41:26 -07:00
.travis.yml	jruby isn't optional	2013-05-23 15:04:05 -07:00
.yardopts	move vendored gems into shared root	2013-05-23 16:06:20 -07:00
CHANGELOG.md	layouts_dir is now configurable. Closes #899	2013-06-01 15:25:44 -07:00
CONTRIBUTING.md	Update CONTRIBUTING.md	2013-06-10 18:20:09 +02:00
gem_rake_helper.rb	update gem builder helper	2013-05-01 10:16:46 -07:00
Gemfile	prybegone	2013-06-09 17:15:15 -07:00
LICENSE.md	add CONTRIBUTING.md / LICENSE.md, rejig README.md / .gemspec	2013-05-17 13:34:15 +01:00
middleman.sublime-project	write some file change and deletion tests for better data coverage	2013-05-29 10:59:03 -04:00
Rakefile	fix #929 : `cd` in Rakefile in a cross-platform way	2013-06-07 23:19:47 +08:00
README.md	fix up simplecov, add coveralls	2013-05-30 13:38:52 -04:00
vendor.yml	Update vendor.yml	2013-06-04 15:23:01 -06:00

README.md

Middleman

Middleman makes developing stand-alone websites simple. The last few years has seen an explosion in the amount and variety of tools developers can use to build web applications. Ruby on Rails selects a handful of these tools:

Sass for DRY stylesheets
CoffeeScript for safer and less verbose javascript
Multiple Asset Management Solutions
ERb & Haml for dynamic pages and simplified HTML syntax

Middleman gives the stand-alone developer access to all these tool and many, many more. Why would you use a stand-alone framework instead of Ruby on Rails?

These days, many websites are built with an API in mind. Rather than package the frontend and the backend together, both can be built and deployed independently using the public API to pull data from the backend and display it on the frontend. Static websites are incredibly fast and require very little RAM. A front-end built to stand-alone can be deployed directly to the cloud or a CDN. Many designers and developers simply deliver static HTML/JS/CSS to their clients.

Install

Middleman is built on Ruby and uses the RubyGems package manager for installation. These are usually pre-installed on Mac OS X and Linux. Windows users can install both using RubyInstaller.

gem install middleman

Getting Started

Once Middleman is installed, you will have access to the middleman command. First, let's create a new project. From the terminal:

middleman init MY_PROJECT

This will create a new Middleman project located in the "MY_PROJECT" directory. This project contains a config.rb file for configuring Middleman and a source directory for storing your pages, stylesheets, javascripts and images.

Change directories into your new project and start the preview server:

cd MY_PROJECT
middleman server

The preview server allows you to build your site, by modifying the contents of the source directory, and see your changes reflected in the browser at: http://localhost:4567/

To get started, simply develop as you normally would by building HTML, CSS, and Javascript in the source directory. When you're ready to use more complex templates, simply add the templating engine's extension to the file and start writing in that format.

For example, say I am working on a stylesheet at source/stylesheets/site.css and I'd like to start using Compass and Sass. I would rename the file to source/stylesheets/site.css.scss and Middleman will automatically begin processing that file as Sass. The same would apply to CoffeeScript (.js.coffee), Haml (.html.haml) and any other templating engine you might want to use.

Finally, you will want to build your project into a stand-alone site. From the project directory:

middleman build

This will compile your templates and output a stand-alone site which can be easily hosted or delivered to your client. The build step can also compress images, employ Javascript & CSS dependency management, minify Javascript & CSS and run additional code of your choice. Take a look at the config.rb file to see some of the most common extensions which can be activated.

Learn More

A full set of in-depth instructional guides are available on the official website at: http://middlemanapp.com.

Additionally, up-to-date generated code documentation is available on RubyDoc.

Build & Dependency Status

Community

The official community forum is available at: http://forum.middlemanapp.com

Bug Reports

Github Issues are used for managing bug reports and feature requests. If you run into issues, please search the issues and submit new problems: https://github.com/middleman/middleman/issues

The best way to get quick responses to your issues and swift fixes to your bugs is to submit detailed bug reports, include test cases and respond to developer questions in a timely manner. Even better, if you know Ruby, you can submit Pull Requests containing Cucumber Features which describe how your feature should work or exploit the bug you are submitting.