Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yivo/pug-rails
👌 Make Jade and Pug play well with Sprockets.
https://github.com/yivo/pug-rails
jade jade-template-engine pug pug-template-engine rails-asset-pipeline ruby ruby-gem ruby-on-rails sprockets
Last synced: about 2 months ago
JSON representation
👌 Make Jade and Pug play well with Sprockets.
- Host: GitHub
- URL: https://github.com/yivo/pug-rails
- Owner: yivo
- License: mit
- Created: 2016-06-03T17:54:31.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-11T23:23:48.000Z (almost 7 years ago)
- Last Synced: 2024-07-10T22:18:00.529Z (2 months ago)
- Topics: jade, jade-template-engine, pug, pug-template-engine, rails-asset-pipeline, ruby, ruby-gem, ruby-on-rails, sprockets
- Language: Ruby
- Homepage:
- Size: 82 KB
- Stars: 32
- Watchers: 5
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-pug - Rails
README
## 👌 Make Jade and Pug play well with Sprockets
[](https://badge.fury.io/rb/pug-rails)
[](https://travis-ci.org/yivo/pug-rails)
## About
`pug-rails` is a gem that allows you to easily integrate Jade / Pug template engine with Rails asset packaging system known as Sprockets.
[pug-ruby](https://github.com/yivo/pug-ruby) is used under the hood. Please refer to the gem if you would like to use Jade / Pug compiler API directly.
## Installing gem
**RubyGems users**
1. Run `gem install pug-rails --version "~> 3.0.0"`.
2. Add `require "pug-rails"` to your code.
**Bundler users**
1. Add to your Gemfile:
```ruby
gem "pug-rails", "~> 3.0.0"
```
2. Run `bundle install`.
## Installing Jade and Pug
See installation steps and notes at [pug-ruby](https://github.com/yivo/pug-ruby#installing-jade). You may not need to do this step.
## Requiring Jade runtime
Put the next line in your asset manifest:
```js
//= require jade-runtime-1.11.0
```
You may change Jade runtime.js version depending on your scenario.
## Naming Jade templates
Use `.jst.jade` as extension of your Jade files.
## Requiring Pug runtime
Put the next line in your asset manifest:
```js
//= require pug-runtime-2.0.2
```
You may change Pug runtime.js version depending on your scenario.
**IMPORTANT:** You don't need to do this if you have configured Pug compiler to inline runtime functions in template. Please read about `inlineRuntimeFunctions` option at official website: [pugjs.org](http://pugjs.org).
## Naming Pug templates
Use `.jst.pug` as extension of your Pug files.
## Configuring Jade / Pug
Configuration documentation is available at [pug-ruby](https://github.com/yivo/pug-ruby#configuring-jade--pug).
## Configuring asset lookup paths
It doesn't matter where to put Jade / Pug files but don't forget to update asset lookup paths.
Personally I prefer to put templates in `app/assets/templates`:
```ruby
# This will add app/assets/templates to asset lookup paths.
#
# Add the next line to your initializers or application.rb:
Rails.application.config.assets.paths << Rails.root.join("app/assets/templates")
```
## Running tests
1. Install both Jade and Pug: `npm install --global jade pug`.
2. Install gem dependencies: `bundle install`.
3. Finally, run tests: `bundle exec appraisal rake test`.
## Versioning
Prior to 2.0 the version of the gem was the same as the version of the Jade runtime that it contained.