uncompiled / amp-bootstrap-example

Example workflow for using Bootstrap with AMP
https://uncompiled.github.io/amp-bootstrap-example/
MIT License
74 stars 33 forks source link
amp-html bootstrap-css

AMP + Bootstrap Example

This is an example of building AMP HTML pages from Bootstrap-based websites.

One of the fundamental differences between standard HTML and AMP HTML is that AMP restricts features which can cause negative performance. However, those restrictions also allow the AMP format to guarantee a baseline for performance.

Bootstrap-related Restrictions

Samples

In this repo, there are two samples of the same website.

The final product is in the build folder.

Workflow

We will focus on cleaning the CSS, leaving the minimum classes required to maintain compatibility with Bootstrap markup. The process of cleaning unused CSS is not specific to Bootstrap or AMP and can be used with any web development asset pipeline, including Rails or Django.

Step 1: Create the AMP HTML

Starting with the Bootstrap version of your page, follow the AMP project documentation to make sure that the AMP version of your page contains the required markup.

Step 2: Remove JS

From the AMP HTML spec:

While it does allow styling the document using custom CSS, it does not allow author written JavaScript beyond what is provided through the custom elements to reach its performance goals.

This means you'll need to remove Bootstrap's JS and jQuery from the AMP version of your page.

If your pages require custom JS, look at implementing Progressive Web App techniques to supercharge your client-side performance.

Step 3: Remove externally linked CSS

AMP pages do not allow external stylesheets, so remove the Bootstrap CSS from the AMP version of your page.

Note that in this example, the AMP version of the HTML includes html-replace markup to allow build-time replacement of the processed CSS:

<!-- build:cssInline -->
<!-- endbuild -->

Step 4: Generate clean CSS

For this example, we'll use Gulp with a few helpers:

To recreate this:

Handling CSS errors

AMP disallows specific styles from being used, so we will run amphtml-validator to find potential problems in the source CSS. In this case, Bootstrap's CSS.

Examples of CSS Restrictions:

Validation is an important part of the build process because we need to ensure that our CSS creates the desired layout and styling while also adhering to the AMP spec.

Bootstrap uses some CSS styles that are not allowed in AMP:

Results

Once the unused (and invalid) classes are stripped from the original Bootstrap CSS, the minified output shrinks from 120kb down to 12kb.

Before

HTML Page

After

AMP HTML Page

The pages should look exactly the same.