bridgetown-slim
Caution
This plugin has been marked deprecated and will no longer be recommended or officially maintained for Bridgetown 2.0+. We will still accept PRs if provided, but make no guarantee it won't break in future Bridgetown versions.
A Bridgetown plugin to provide support for Slim templates.
Installation for Bridgetown 1.2+
Run this command to add this plugin to your site's Gemfile:
$ bundle add bridgetown-slim
And then add the initializer to your configuration in config/initializers.rb
:
init :"bridgetown-slim"
(For Bridgetown 1.1 or earlier, read these instructions.)
Usage
Simply name your page, layout, or partial with a .slim
extension. The available features will be fairly analogous to the ERB support in Bridgetown, including support for helpers, partials, and rendering Liquid components. You can even embed Markdown and other template languages 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
- Fork it (https://github.com/bridgetownrb/bridgetown-slim/fork)
- Clone the fork using
git clone
to your local development machine. - Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
Examples
- Template using Slim, Bridgetown, Tailwind 2.0, and Snowpack. https://github.com/ParamagicDev/bridgetown-slim-starter