Utilities to simplify Accelerated Mobile Pages (AMP) implementation in Rails apps.
Implemented:
Todo:
Minimum supported MRI version is 2.2.6. JRuby is not supported.
The gem should work on Mac, Linux and Windows, however testing
is limited as follows:
2.4.02.3.32.2.62.4.02.3.32.2.6HeadAdd this line to your application's Gemfile:
gem 'roll-amp'
And then execute:
$ bundle
Or install it yourself as:
$ gem install roll-amp
<%= amp_js %>
Includes https://cdn.ampproject.org/v0.js script at a place where the amp_js
tag was specified.
This tag is required for AMP.
<%= amp_boilerplate %>
Includes basic CSS suggested at https://www.ampproject.org/docs/get_started/create/basic_markup
app/stylesheets of your Rails app.
For example app/stylesheets/amp/application.scss.<%= amp_custom_style('amp/application') %>
When amp/application is available in the assets pipeline,
its content will be loaded from there. Otherwise such file will be searched in
the public directory.
Usually it’s sufficient to create CSS file and Rails will handle the rest.
Please note, AMP sets 50K limit on CSS size. If you include larger stylesheet
your pages won’t be valid.
amp_js:<%= amp_analytics_js %>
<%=
amp_google_analytics(
'UA-00000-1',
{
trackPageview: {
on: 'visible',
request: 'pageview'
}
}
)
%>
First parameter is Google Analytics account ID. Second parameter defines triggers. Please see Adding Analytics to your AMP pages to learn about triggers. The example above shows the most common configuration.
<!doctype html>
<html ⚡>
<head>
<%= amp_analytics_js %>
<%= amp_js %>
<%= csrf_meta_tags %>
<%= amp_boilerplate %>
<%= amp_custom_style('amp/application') %>
</head>
<body>
<%=
amp_google_analytics(
'UA-00000-1',
{
trackPageview: {
on: 'visible',
request: 'pageview'
}
}
)
%>
<%= yield %>
</body>
</html>
After checking out the repo, run bin/setup to install dependencies.
Then, run rake spec to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install.
To release a new version, update the version number in version.rb,
and then run bundle exec rake release, which will create a git tag for
the version, push git commits and tags, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/roll-rails/roll-amp. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.
FAQs
Unknown package
We found that roll-amp demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.