Skip to content
A Jekyll html theme in the vague style of Medium.com built using Google AMP
CSS HTML Ruby
Find file
Pull request Compare This branch is even with gh-pages.
Latest commit 1a88054 Adam Geitgey Url fixes
Failed to load latest commit information.
_includes Url fixes
_layouts Initial commit
_posts Initial commit
_sass Initial commit
assets/images Initial commit
.gitignore Initial commit
Gemfile Initial commit
Gemfile.lock Initial commit
LICENSE Initial commit
README.md Initial commit
_config.yml Config basic settings
about.md Initial commit
feed.xml Initial commit
index.html Url fixes

README.md

Amplify for Jekyll

A Jekyll html theme in the vague style of Medium.com built using Google AMP

Google's Accelerated Mobile Pages Project (a.k.a. "Google AMP" or Google ) is an open-source project that defines rules for creating websites that load nearly instantly even on mobile devices with slow connections.

Why use Google AMP?

There are two reasons to use Google AMP:

First, it's really fast! An often sited claim (by Amazon, Yahoo, Walmart and others) is that every extra 100ms improvement in page load time increases incremental revenue by up to 1%. Your personal blog might not be selling anything, but why settle for a slow page and risk losing readers?

Second, Google might feature your AMP page in Search Results! Google gives preferential treatment to AMP pages on Mobile Search. When it displays your page in the AMP search results widget, it will even serve your page through it's own CDN to make the page load even faster. It's similar to how Facebook Instant Articles works on the Facebook platform.

Getting Started

To use this theme, it's dead simple and just like using any other Jekyll template:

Step 1: Install Jekyll

Step 2: Clone this repo to your computer

git clone <blah>

Step 3: Tweak _config.yml.

Just fill in everything in the # Site settings section. You'll want to set your site's title, your name, your twitter username, etc.

Step 4: Run jekyll serve and then open http://localhost:4000/ to see your site!

Step 5: Publish your site just like any other Jekyll site.

Google AMP Limitations

Google AMP sets many strict limits on what you can include in your web pages. A few of these are worth talking about:

Limitation: All CSS must be inline (no external css files).

Because of this, the main css file for this site is in _includes/styles.scss instead of in the normal css/ Jekyll folder. This css file is inlined into the header of every page via the special scssify filter in _includes/head.html.

Limitation: Size all resources statically

Every image you include in your page must have a height and width. This also applies to other things like embedding videos or other resources. Check below for more details.

Writing Posts with Google AMP

Writing posts works just like it does normally in Jekyll except when you want to include extra resources likes pictures, videos, embedded Twitter posts, etc.

Google AMP has it's own set of special html tags for including content. You should use these instead of normal Markdown or HTML tags.

The two you are are most likely to need are <amp-img> and <amp-youtube>:

Images in your posts

<amp-img width="600" height="300" layout="responsive" src="/assets/images/your_picture.jpg"></amp-img>

Youtube Videos in your posts

<amp-youtube data-videoid="NpEaa2P7qZI" layout="responsive" width="480" height="270"></amp-youtube>

Embedding other types of content

The AMP Project provides helpers for many other types of content like audio, ads, Google Analytics, etc.

Validating your page with Google AMP

Google AMP adds built-in validation logic to make sure your pages follow all the rules so they render as fast as possible.

To check your page, just add #development=1 to any url on your site and then check the javascript console in your browser.

http://localhost:4000/#development=1

You will either see a success message:

Powered by AMP ⚡ HTML – Version 1457112743399
AMP validation successful.

Or you will see a list of errors to fix:

Powered by AMP ⚡ HTML – Version 1457112743399
AMP validation had errors:
The attribute 'style' may not appear in tag 'span'
The attribute 'style' may not appear in tag 'div'

Making Google serve your page

Google will cache valid AMP pages if you link to them with one of these urls:

https://cdn.ampproject.org/c/s/<your page url here>

Or:

https://amp.gstatic.com/c/s/<your page url here>

But keep in mind these two limitations:

  1. The caches don't refresh that often. So don't view these urls until your page is done!
  2. Remove /s from both urls if your page isn't served over https://.

Required Schema Data

To actually get your page featured in Google search results, it needs to include a http://schema.org NewsArticle schema. See _includes/metadata.json for the version generated by default. You might want to tweak it.

Credits

This theme is inspired by Mediator by Dirk Fabisch. I used some of the css and html from that theme as a starting point. Thanks!

License

MIT. See LICENSE file in repo.

Something went wrong with that request. Please try again.