Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/middleman/middlemanapp.com

Documentation for Middleman
https://github.com/middleman/middlemanapp.com

documentation guides middleman

Last synced: 9 days ago
JSON representation

Documentation for Middleman

Awesome Lists containing this project

README

        

Middleman Guides
================

[![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)

These are the source files that power the [Middleman website](https://middlemanapp.com/),
which is itself a [Middleman](https://github.com/middleman/middleman)-powered static page.

The guides are the primary documentation for Middleman, explaining the core features and extensions as well as pointing out community extensions.

Middleman is ever-vigilant against tag-soup, unreadable CSS and repetition. It stands-watch
over your Haml, Sass, and CoffeeScript producing only the cleanest and most efficient
markup.

## How to run the site locally

Make sure you have Ruby 1.9.3+, [Bundler] and [npm] installed.

1. Set up your machine:

```bash
bin/setup
```

1. Start the server:

```bash
bundle exec middleman server
```

1. Open .

[Bundler]: http://bundler.io/
[npm]: https://docs.npmjs.com/

## Mailing List

If you have questions, answers can be found on our [community forum](http://forum.middlemanapp.com/).

## Contributing

Please help Middleman flesh out its documentation. We'll merge in any reasonable
extensions to our website docs, and give credit for your help!

The guides are written in [Markdown](http://daringfireball.net/projects/markdown/).

## Donate

Please, [help support the Middleman team with a donation](https://github.com/sponsors/tdreyno).

## Copyright

Copyright (c) Thomas Reynolds. [Creative Commons Attribution 3.0 Unported License](http://creativecommons.org/licenses/by/3.0/).