Sha256: c4abc4b2651079339bd3aa64b9d58a68fd6080b5692bbbce4bc0a76c119c8f7a

Contents?: true

Size: 1.45 KB

Versions: 2

Compression:

Stored size: 1.45 KB

Contents

# bridgetown-slim

A Bridgetown plugin to provide support for [Slim templates](http://slim-lang.com).

_Requires Bridgetown 0.16 or greater._

## Installation

Run this command to add this plugin to your site's Gemfile:

```shell
$ bundle add bridgetown-slim -g bridgetown_plugins
```

## Usage

Simply name your page, layout, or partial with a `.slim` extension. The available features will be fairly analogous to [the ERB support](https://www.bridgetownrb.com/docs/erb-and-beyond#haml-and-slim) in Bridgetown, including support for helpers, partials, and rendering Liquid components. You can even [embed Markdown and other template languages](https://github.com/slim-template/slim#embedded-engines-markdown-) using standard Slim syntax.

You can also add `template_engine: slim` to your file's front matter and use any extension you want. For example, you could add `data.xml` to your source folder and simply make sure the front matter contains `template_engine: slim`.

## Testing

* Run `bundle exec rspec` to run the test suite
* Or run `script/cibuild` to validate with Rubocop and test with rspec together.

## Contributing

1. Fork it (https://github.com/bridgetownrb/bridgetown-slim/fork)
2. Clone the fork using `git clone` to your local development machine.
3. Create your feature branch (`git checkout -b my-new-feature`)
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
bridgetown-slim-1.1.1 README.md
bridgetown-slim-1.1.0 README.md