https://github.com/railsware/sht_rails

Shared handlebars templates for Rails 3
https://github.com/railsware/sht_rails

Last synced: 7 months ago
JSON representation

Shared handlebars templates for Rails 3

• Host: GitHub
• URL: https://github.com/railsware/sht_rails
• Owner: railsware
• License: mit
• Created: 2012-05-19T21:36:59.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2016-04-30T08:57:09.000Z (over 9 years ago)
• Last Synced: 2024-12-11T10:37:09.784Z (about 1 year ago)
• Language: Ruby
• Homepage: http://blog.railsware.com/2012/05/21/shared-handlebars-templates-for-rails-3/
• Size: 66.4 KB
• Stars: 76
• Watchers: 7
• Forks: 21
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ShtRails

Shared handlebars templates for rails 3 and 4.

## Installation

Add this line to your application's Gemfile:

    gem 'sht_rails'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install sht_rails

## Usage

    $ rails g sht_rails:install

Generator add into "application.js" requirements for mustache and "templates" folder in "app". Next you can create handlebars templates in this folder or subfolders.

For example:

File: "app/templates/tests/_test.handlebars"

    Hello {{msg}}!!!

In view you can render this template by this way:

    <%= render "tests/test", :handlebars => {msg: "Test"} %>

The same template you can render in JavaScript:

    var content = SHT['tests/test']({msg: "Test"});

## Configuration

    ShtRails.configure do |config|

      config.template_extension = 'handlebars' # change extension of mustache templates

      config.action_view_key    = 'handlebars' # change name of key for rendering in ActionView mustache template

      config.template_namespace = 'SHT'      # change templates namespace in javascript

      config.template_base_path = Rails.root.join("app", "templates") # templates dir

    end

### Note on precompiling assets and custom configs

In Rails, if you have config.assets.initialize\_on\_precompile set to false, but have placed the above config in an initializer, it will not run. To get around this, you can do the following in application.rb:

    if "assets" == ENV["RAILS_GROUPS"] || ["development", "test"].include?(ENV["RAILS_ENV"])

      ShtRails.template_namespace = 'JST'

    end

## Demo

Site: [http://st-rails-example.herokuapp.com](http://st-rails-example.herokuapp.com)

Source code: [https://github.com/le0pard/st_rails_example](https://github.com/le0pard/st_rails_example)

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Added some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request