Table of contents

amp-gist

Description

Creates an iframe and displays a GitHub Gist.

Required Scripts

<script async custom-element="amp-gist" src="https://cdn.ampproject.org/v0/amp-gist-0.1.js"></script>

Supported Layouts

fixed-height

Usage

Creates an iframe and displays a GitHub Gist.

The following example shows how to embed multiple files:

<amp-gist
  data-gistid="b9bb35bc68df68259af94430f012425f"
  layout="fixed-height"
  height="225"
>
</amp-gist>

The following example shows how to embed a single file:

<amp-gist
  data-gistid="a19e811dcd7df10c4da0931641538497"
  data-file="hi.c"
  layout="fixed-height"
  height="185"
>
</amp-gist>

Attributes

`data-gistid`

The ID of the gist to embed.

`layout`

Currently only supports fixed-height.

`height`

The initial height of the gist or gist file in pixels.

You should obtain the height of the gist by inspecting it with your browser (e.g., Chrome Developer Tools). Once the Gist loads the contained iframe will resize to fit so that its contents will fit.

`data-file` (optional)

If specified, display only one file in a gist.

title (optional)

Define a title attribute for the component to propagate to the underlying <iframe> element. The default value is "Github gist".

Validation

See amp-gist rules in the AMP validator specification.

Need more help?

You've read this document a dozen times but it doesn't really cover all of your questions? Maybe other people felt the same: reach out to them on Stack Overflow.

Go to Stack Overflow

Found a bug or missing a feature?

The AMP project strongly encourages your participation and contributions! We hope you'll become an ongoing participant in our open source community but we also welcome one-off contributions for the issues you're particularly passionate about.

Go to GitHub

amp-gist 1.0 0.1