Download the PHP package dorsetdigital/silverstripe-amppages without Composer
On this page you can find all versions of the php package dorsetdigital/silverstripe-amppages. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dorsetdigital/silverstripe-amppages
More information about dorsetdigital/silverstripe-amppages
Files in dorsetdigital/silverstripe-amppages
Package silverstripe-amppages
Short Description Provides a basic support framework for AMP pages in SS4
License BSD-3-Clause
Homepage https://github.com/DorsetDigital/silverstripe-amppages
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package silverstripe-amppages
silverstripe-amppages
Adds semi-automated AMP page functionality and provides some basic assistance in creating AMP pages in Silverstripe 4.
Requirements
*Silverstripe 4.0.x
Installation
- Install the code with
composer require dorsetdigital/silverstripe-amppages - Run a
dev/build?flushto update your project
Usage
Please note: this is not an 'out-of-the-box' solution, you'll need to do some work as well!
The add-on provides some of the basic framework for getting your site AMP-enabled. For pages in the SiteTree, a link is added to the html head which points at an AMP version of the page. There are base templates to deal with the fundamental requirements. These include some basic AMP boilerplate.
The controller which handles the AMP pages forcibly removes any scripts, CSS, etc. added via Requirements to the parent page. This is due to the strict limitations on what can be included in AMP.
There is a base page template called Amp.ss and additional page types can be templated by adding a file called ClassName_amp.ss to your theme in the same directory as the non-AMP template.
In line with the AMP recommendations, CSS should be minified and included inline in the page.
To try and keep a consistent workflow, the Requirements class has been extended to provide the ability to inject AMP CSS into the AMP version of the page automatically.
It can be used in your page controller class as follows:
The above would automatically find a CSS file called amp.css in your theme's CSS directory and add the contents inline in the correct <style amp-custom> tag. Additional style sheets can be added by calling the ampCSS() method again, they will be appended. (Just remember, there's a size limit on the amount of CSS in AMP)
Useful Links
See The AMP Project for more information about what you can and can't do in an AMP page
Credits
- Very much inspired by Silverstripe AMP HTML for SS3
- Thanks to the Silverstripe Slack users for their patient assistance Slack channel signup
- As always, thanks to the core team for all their hard work.
