Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tyom/middleman-skeleton
Preconfigured Middleman template: Slim, Bourbon+Neat, Font Awesome and a handful of helpers.
https://github.com/tyom/middleman-skeleton
Last synced: 2 days ago
JSON representation
Preconfigured Middleman template: Slim, Bourbon+Neat, Font Awesome and a handful of helpers.
- Host: GitHub
- URL: https://github.com/tyom/middleman-skeleton
- Owner: tyom
- Created: 2014-08-27T15:48:56.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2014-10-02T18:35:01.000Z (about 10 years ago)
- Last Synced: 2023-03-22T11:49:19.163Z (over 1 year ago)
- Language: Ruby
- Homepage:
- Size: 273 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Middleman Skeleton
==================
Middleman template pre-configured with [Slim](https://github.com/slim-template/slim), [Bourbon](https://github.com/thoughtbot/bourbon) + [Neat](https://github.com/thoughtbot/neat), [Normalize CSS](https://github.com/JohnAlbin/normalize-scss), [Font Awesome Sass](https://github.com/FortAwesome/font-awesome-sass), [Autoprefixer](https://github.com/porada/middleman-autoprefixer), LiveReload and a few useful helpers.
### Installation
Past the following in your terminal. This install this Middleman template in `~/.middleman/skeleton`.
```
(export D=~/.middleman/skeleton; mkdir -p ${D}; curl -L https://github.com/tyom/middleman-skeleton/tarball/master | tar --strip-components=1 -C ${D} -xf-)
```
To start new projects based on this template:
```
middleman init my-new-project -T skeleton
```
### Template helpers
#### `resources_for`
List resources for a specific path.
Parameters:
- `path` - required.
- `ext` - optional. Resource extension (defaults to `html`)
- `exclude_indexes` - optional. Whether to exclude directory indexes from the list of resources (defaults to `false`)
#### `local_data`
Load local data from YAML or JSON file. e.g. `= local_data '../data.yaml'
Parameters:
- `path` - required. Relative path to YAML file, including file extension.
#### `get`
Make an HTTP GET request using [Rest Client](https://github.com/rest-client/rest-client).
Parameters:
- `url` - required. Resource URL.
- `options` - optional. Headers or parameters.
e.g. `= get 'https://user:[email protected]/resource', { params: { filter: 'desc' }, accept: 'application/json' }`
#### `post`
Make an HTTP POST request using [Rest Client](https://github.com/rest-client/rest-client).
Parameters:
- `url` - required. Resource URL.
- `params` - optional. Parameters. Passing Ruby hash will force Content-Type to `application/x-www-form-urlencoded`. To use custom Content-Type quote passed JSON.
e.g. `= post 'https://user:[email protected]/resource', '{ "name": "Bob" }'`
- `headers` - optional. Custom headers
e.g. `= post 'https://user:[email protected]/resource', '{}' { accept: 'application/json' }`
### Frontmatter
There are two special parameters set in [Middleman’s Frontmatter](http://middlemanapp.com/basics/frontmatter/):
`javascripts` and `stylesheets`. When set, JavaScript and stylesheets are inserted in that particular page.
This is useful for prototyping or creating a page that is different from all other pages in style or functionality (or both).
The parameters can be plural or singular and can take YAML list, single name or comma separated list of names. Paths can be absolute or relative as well as external URL. If prefixed with `/` `source` directory will be used as root. Dot-prefixes are accepted for relative paths. `.css`, `.js` extensions are optional. Files can be in CoffeeScript or Sass (save as `name.css.scss`), Middleman will take care of finding and processing the file.
For example:
```yaml
---
stylesheet: ../style
javascripts: my-app.js, /assets/javascripts/global
---
---
stylesheets:
- http://static.bbci.co.uk/h4base/0.209.13/style/h4base.css
- ./bbc-local
javascripts:
- ../../above.js
- further/down.js
---
```