Gakubuchi provides a simple way to manage static pages (e.g. error pages) with Asset Pipeline.
Put this in your Gemfile:
gem 'gakubuchi'
Run the installation generator with:
rails g gakubuchi:install
Or specify the name of directory for static pages:
rails g gakubuchi:install -d html
They will install the initializer into config/initializers/gakubuchi.rb
and create the directory in app/assets
.
If you don't specify the -d
option, templates
will be used as default.
In app/assets/templates/404.html.slim
:
doctype html
html
head
title The page you were looking for doesn't exist (404)
meta name='viewport' content='width=device-width,initial-scale=1'
= stylesheet_link_tag 'application', media: 'all'
body
.dialog
div
h1 The page you were looking for doesn't exist.
p You may have mistyped the address or the page may have moved.
p If you are the application owner check the logs for more information.
Open the following URL in your browser to check the templeate:
http://localhost:3000/assets/404.html
Compile the templeate with:
rails assets:precompile
This will generate public/404.html
.
Gakubuchi supports some template engines: ERB
, Haml
and Slim
.
When you want to use Haml
or Slim
, you need to put them in your Gemfile:
# Use Haml
gem 'haml'
# Use Slim
gem 'slim'
Gakubuchi enables you to use assets (e.g. CSS
or JavaScript
files) in static pages.
Note that you may need to add them to the precompile array in config/initializers/assets.rb
:
Rails.application.config.assets.precompile += %w(error.css error.js)
You can also use helpers provided by Sprockets::Rails::Helper
in static pages.
Examples of them are given below.
asset_path
content_tag
favicon_link_tag
image_tag
javascript_include_tag
If you want to get the list of all available helpers, please execute the following code.
Sprockets::Rails::Helper.instance_methods
In config/initializers/gakubuchi.rb
, you can configure the following values.
leave_digest_named_templates # false by default
template_directory # 'templates' by default
You should follow the steps below.
- Fork the repository
- Create a feature branch:
git checkout -b add-new-feature
- Commit your changes:
git commit -am 'Add new feature'
- Push the branch:
git push origin add-new-feature
- Send us a pull request
We use Appraisal to test with different combinations of sprockets and sprockets-rails.
bundle install
appraisal install
# Run RSpec with a specific combination
appraisal 'sprockets-rails 3 with sprockets 4' rspec
# Run RSpec with all combinations
appraisal rspec
MIT License. Copyright 2015 Yuichi Goto.