silverstripers/amp

Provide AMP HTML conversion to your SilverStripe project

SilverStripe AMP

AMP HTML⚡ Bundle - provide AMP HTML conversion to your SilverStripe website., _(*1)

Requirements

• lullabot/amp ^1.1.3
• silverstripe/framework 4+

Installation & Usage

Install with composer, _(*2)

composer require silverstripers/amp dev-master

Configurations

Clearing Caches

To clear the amp caches you need to set up an RSA Key., _(*3)

Follow the instructions on the AMP Cache guide on Generating Keys., _(*4)

To set up the private key use the following YAML configutation, _(*5)

SilverStripers\AMP\Control\AMPCache:
    key_file: 'PATH_TO_YOUR_PRIVATE_KEY'

Setting up class names

The module allows you to set up class name of pages which are supported by AMPs., _(*6)

---
Name: amps
---
SilverStripers\AMP\Control\AMPDirector:
  allowed_classes:
    - SilverStripe\Blog\Model\Blog
    - SilverStripe\Blog\Model\BlogPost

The configs above limits the amps support to Blog and BlogPost pages., _(*7)

This module adds extensions on for your controllers where the pages will have an AMP based version with a URL suffix for each page., _(*8)

EG:, _(*9)

/home/ will have /home/amp.html /about-us/ will have /about-us/amp.html, _(*10)

The mobile also provides a template global $IsAMP which you can use on any template to add specific HTML segments for the AMP version of the website., _(*11)

The module adds cannonical URLs and amphtml links for the sites as well., _(*12)

$IsAMP

In order to determine whether the current request is in AMP or not you can use $IsAMP variable., _(*13)

<% if $IsAMP %>
<!-- YOUR AMP CODES HERE -->
<% end_if %>

Same way you can use the not as well, _(*14)

<% if not $IsAMP %>
<!-- YOUR NONE AMP CODES HERE -->
<% end_if %>

Elemental

The module supports elemental module., _(*15)

If you are having to override the templates for Elemental objects you can have templates with _AMP suffix, when those templates are found the elements gets rendered using those., _(*16)

Reporting Issues

Please create an issue for any bugs, or submit merge requests., _(*17)