amp-html 0.7.18 → 1.0.0

data/lib/amp-html/helpers/docs/amp_analytics.md

@@ -1,76 +0,0 @@
-
-# [Helpers](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#amp-html-helpers) / `amp_analytics`
-
-
-## Information
-
-`amp_analytics` allows to integrate with venders to measure activity on AMP documents.
-
----
-
-### Quick info
-
-#### Latest update: 0.6.2 (Pre-release) - 2017-03-20
-
-[**Changelog for version 0.6.2**](https://github.com/slooob/amp-html/blob/master/CHANGELOG.md#062-pre-release---2017-03-20)
-
-#### [DeepIntegration](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#deepintegration-helpers): Enabled
-
-#### [Availability](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#availability-of-helpers): Installable with the [Analytics Component](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs/analytics.md)
-
-#### [Takes a block?](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#takes-a-block): Yes
-
----
-
-## General
-
-### Reference
-
-[**AMP Reference**](https://www.ampproject.org/docs/reference/components/ads/amp-analytics)
-
-#### Required Parameters
-
-* `vendor` (if not set in the AMP-HTML configuration)
-
-#### Structure
-
-    <%= amp_analytics(vendor, options) %>
-    # <amp-analytics type=vendor></amp-analytics>
-
-
-## Examples
-
-Loading a remote config:
-
-    <%= amp_ad("adobeanalytics", config: "https://example.com/analytics.config.json") %>
-
-`amp_analytics` also takes a block:
-
-    <%= amp_analytics do %>
-        <script type="application/json">
-            {
-                "requests": {
-                    "pageview": "https://example.com/analytics?url=${canonicalUrl}&title=${title}&acct=${account}",
-                    "event": "https://example.com/analytics?eid=${eventId}&elab=${eventLabel}&acct=${account}"
-                },
-                "vars": {
-                    "account": "ABC123"
-                },
-                "triggers": {
-                    "trackPageview": {
-                        "on": "visible",
-                        "request": "pageview"
-                    },
-                    "trackAnchorClicks": {
-                        "on": "click",
-                        "selector": "a",
-                        "request": "event",
-                        "vars": {
-                            "eventId": "42",
-                            "eventLabel": "clicked on a link"
-                        }
-                    }
-                }
-            }
-        </script>
-    <% end %>

data/lib/amp-html/helpers/docs/amp_anim.md

@@ -1,68 +0,0 @@
-
-# [Helpers](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#amp-html-helpers) / `amp_anim`
-
-
-## Information
-
-`amp_anim` allows to use runtime-managed animated images, typically GIF's, in AMP documents.
-
----
-
-### Quick info
-
-#### Latest update: 0.6.1 (Pre-release) - 2017-03-19
-
-[**Changelog for version 0.6.1**](https://github.com/slooob/amp-html/blob/master/CHANGELOG.md#061-pre-release---2017-03-19)
-
-#### [DeepIntegration](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#deepintegration-helpers): Disabled
-
-#### [Availability](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#availability-of-helpers): Installable with the [Animated Images Component](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs/anim.md)
-
-#### [Takes a block?](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#takes-a-block): Yes
-
----
-
-## General
-
-### Reference
-
-[**AMP Reference**](https://www.ampproject.org/docs/reference/components/media/amp-anim)
-
-#### Required Parameters
-
-* `source`
-* `size` (or `width` & `height`)
-
-#### Structure
-
-    <%= amp_anim(source, options) %>
-    # <amp-anim src=source layout="responsive"></amp-ad>
-
-**Note:** `layout` defaults to `responsive` if not explicitly permitted.
-
-
-## Examples
-
-Setting width & height:
-
-    <%= amp_anim("my-gif.gif", width: 400, height: 300) %>
-    <%= amp_anim("my-gif.gif", size: "400x300") %>
-    # <amp-anim type="my-gif.gif" layout="responsive" width=400 height=300></amp-ad>
-
-Setting a placeholder:
-
-    <%= amp_anim("my-gif.gif", placeholder: "my-gif-screencap.jpg") %>
-    # <amp-anim src="my-gif.gif" layout="responsive">
-    #     <amp-img placeholder src="my-gif-screencap.jpg"></amp-img>
-    # </amp-anim>
-
-`amp_anim` also takes a block:
-
-    <%= amp_anim("my-gif.gif", width: 400, height: 300) do %>
-        <%= amp_placeholder("amp-anim", width: 400, height: 300, src: "my-gif-screencap.jpg") %>
-    <% end %>
-    # <amp-anim src="my-gif.gif" layout="responsive">
-    #     <amp-img placeholder src="my-gif-screencap.jpg"></amp-img>
-    # </amp-anim>
-
-**References:** [`amp_placeholder`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_placeholder.md)

data/lib/amp-html/helpers/docs/amp_audio.md

@@ -1,54 +0,0 @@
-
-# [Helpers](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#amp-html-helpers) / `amp_audio`
-
-
-## Information
-
-`amp_audio` allows to directly embed audio files with HTML5.
-
----
-
-### Quick info
-
-#### Latest update: 0.7.5 (Pre-release) - 2017-03-23
-
-[**Changelog for version 0.7.5**](https://github.com/slooob/amp-html/blob/master/CHANGELOG.md#075-pre-release---2017-03-23)
-
-#### [DeepIntegration](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#deepintegration-helpers): Disabled
-
-#### [Availability](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#availability-of-helpers): Build-in with the [Media Component](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs/media.md)
-
-#### [Takes a block?](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#takes-a-block): No
-
----
-
-## General
-
-### Reference
-
-[**AMP Reference**](https://www.ampproject.org/docs/reference/components/media/amp-audio)
-
-#### Required Parameters
-
-* `*sources`
-
-#### Structure
-
-    <%= amp_audio(*sources) %>
-    # <amp-audio>
-    #     <div fallback><p>Your browser doesn’t support HTML5 audio</p></div>
-    #     <source type=type_of_source src=source></source>
-    # </amp-audio>
-
-**Note:** `layout` defaults to `responsive` if not explicitly permitted.
-
-
-## Examples
-
-Setting a custom fallback:
-
-    <%= amp_audio("audio_file.mp3", fallback: "No audio here.") %>
-    # <amp-audio>
-    #     <div fallback><p>No audio here.</p></div>
-    #     <source type="audio/mp3" src="audio_file.mp3"></source>
-    # </amp-audio>

data/lib/amp-html/helpers/docs/amp_auto_ads.md

@@ -1,43 +0,0 @@
-
-# [Helpers](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#amp-html-helpers) / `amp_auto_ads`
-
-
-## Information
-
-`amp_auto_ads` allows to autmatically embed ads by a provider.
-
----
-
-### Quick info
-
-#### Latest update: 0.6.2 (Pre-release) - 2017-03-20
-
-[**Changelog for version 0.6.2**](https://github.com/slooob/amp-html/blob/master/CHANGELOG.md#062-pre-release---2017-03-20)
-
-#### [DeepIntegration](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#deepintegration-helpers): Disabled
-
-#### [Availability](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#availability-of-helpers): Installable with the [Advertisements Component](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs/ad.md)
-
-#### [Takes a block?](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#takes-a-block): No
-
----
-
-## General
-
-### Reference
-
-[**AMP Reference**](https://www.ampproject.org/docs/reference/components/ads/amp-auto-ads)
-
-#### Required Parameters
-
-* `network` ([List of supported auto-ads networks](https://www.ampproject.org/docs/reference/components/ads/amp-auto-ads#supported-ad-networks))
-
-#### Structure
-
-    <%= amp_auto_ads(network, options) %>
-    # <amp-auto-ad type=network></amp-ad>
-
-
-## Examples
-
-Some examples may be here in the future.

data/lib/amp-html/helpers/docs/amp_css.md

@@ -1,37 +0,0 @@
-
-# [Helpers](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#amp-html-helpers) / `amp_css`
-
-
-## Information
-
-`amp_css` allows allows the use of stylesheets in AMP documents.
-
----
-
-### Quick info
-
-#### Latest update: 0.6.1 (Pre-release) - 2017-03-19
-
-[**Changelog for version 0.6.1**](https://github.com/slooob/amp-html/blob/master/CHANGELOG.md#061-pre-release---2017-03-19)
-
-#### [DeepIntegration](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#deepintegration-helpers): Disabled
-
-#### [Availability](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#availability-of-helpers): Build-in with the [Stylesheets Component](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs/stylesheets.md)
-
-#### [Takes a block?](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#takes-a-block): Yes
-
----
-
-## General
-
-### Reference
-
-#### Required Parameters
-
-None.
-
-#### Structure
-
-    <%= amp_css do %>
-        /* Your CSS here */
-    <% end %>

data/lib/amp-html/helpers/docs/amp_embed.md

@@ -1,86 +0,0 @@
-
-# [Helpers](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#amp-html-helpers) / `amp_embed`
-
-
-## Information
-
-`amp_embed` allows to easily embed ads with AMP, not hurting performance. It is an alias to the [`amp_ad`](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs/amp_ad.md) helper.
-
----
-
-### Quick info
-
-#### Latest update: 0.5.4 (Pre-release) - 2017-03-19
-
-[**Changelog for version 0.5.4**](https://github.com/slooob/amp-html/blob/master/CHANGELOG.md#054-pre-release---2017-03-19)
-
-#### [DeepIntegration](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#deepintegration-helpers): Enabled
-
-#### [Availability](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#availability-of-helpers): Installable with the [Advertisements Component](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs/ad.md)
-
-#### [Takes a block?](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#takes-a-block): Yes
-
----
-
-## General
-
-### Reference
-
-[**AMP Reference**](https://www.ampproject.org/docs/reference/components/ads/amp-ad)
-
-#### Required Parameters
-
-* `network` (if not set in the AMP-HTML configuration)
-* `size` (or `width` & `height`)
-
-#### Structure
-
-    <%= amp_embed(network, options) %>
-    # <amp-ad type=network layout="responsive"></amp-ad>
-
-**Note:** `layout` defaults to `responsive` if not explicitly permitted.
-
-
-## Examples
-
-Setting width & height:
-
-    <%= amp_embed("a9", width: 400, height: 300) %>
-    <%= amp_embed("a9", size: "400x300") %>
-    # <amp-ad type="a9" layout="responsive" width=400 height=300></amp-ad>
-
-Creating a sticky ad at the bottom of the viewport:
-
-    <%= amp_embed("a9", sticky: true) %>
-    # <amp-sticky-ad layout="nodisplay">
-    #     <amp-ad type="a9" layout="responsive"></amp-ad>
-    # </amp-sticky-ad>
-
-Setting a placeholder:
-
-    <%= amp_embed("a9", placeholder: "my-ad-screencap.jpg") %>
-    # <amp-ad type="a9" layout="responsive">
-    #     <amp-img placeholder src="my-ad-screencap.jpg"></amp-img>
-    # </amp-ad>
-
-Setting a fallback:
-
-    <%= amp_embed("a9", fallback: "my-ad-screencap.jpg") %>
-    # <amp-ad type="a9" layout="responsive">
-    #     <amp-img fallback src="my-ad-screencap.jpg"></amp-img>
-    # </amp-ad>
-
-**Note:** Currently you can only pass `sticky` **or** `placeholder` **or** `fallback` as an option.
-
-`amp_ad` also takes a block:
-
-    <%= amp_embed("a9", options) do %>
-        <%= amp_placeholder("amp-img", src: "my-ad-screencap.jpg") %>
-        <%= amp_fallback("amp-img", src: "my-ad-screencap.jpg") %>
-    <% end %>
-    # <amp-ad type="a9" layout="responsive">
-    #     <amp-img placeholder src="my-ad-screencap.jpg"></amp-img>
-    #     <amp-img fallback src="my-ad-screencap.jpg"></amp-img>
-    # </amp-ad>
-
-**References:** [`amp_placeholder`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_placeholder.md), [`amp_fallback`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_fallback.md)

data/lib/amp-html/helpers/docs/amp_facebook.md

@@ -1,70 +0,0 @@
-
-# [Helpers](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#amp-html-helpers) / `amp_facebook`
-
-
-## Information
-
-`amp_facebook` allows to easily embed ads with AMP, not hurting performance.
-
----
-
-### Quick info
-
-#### Latest update: 0.6.2 (Pre-release) - 2017-03-20
-
-[**Changelog for version 0.6.2**](https://github.com/slooob/amp-html/blob/master/CHANGELOG.md#062-pre-release---2017-03-20)
-
-#### [DeepIntegration](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#deepintegration-helpers): Disabled
-
-#### [Availability](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#availability-of-helpers): Installable with the [Social Component](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs/social.md)
-
-#### [Takes a block?](https://github.com/slooob/amp-html/tree/master/lib/amp-html/helpers/docs#takes-a-block): Yes
-
----
-
-## General
-
-### Reference
-
-[**AMP Reference**](https://www.ampproject.org/docs/reference/components/social/amp-facebook)
-
-#### Required Parameters
-
-* `href`
-* `size` (or `width` & `height`)
-
-#### Structure
-
-    <%= amp_facebook(href, options) %>
-    # <amp-facebook data-href=href layout="responsive"></amp-facebook>
-
-**Note:** `layout` defaults to `responsive` if not explicitly permitted.
-
-
-## Examples
-
-Setting width & height:
-
-    <%= amp_facebook("https://www.facebook.com/zuck/posts/10102593740125791", width: 486, height: 657) %>
-    <%= amp_facebook("https://www.facebook.com/zuck/posts/10102593740125791", size: "486x657") %>
-    # <amp-facebook data-href="https://www.facebook.com/zuck/posts/1010259374012579"1 layout="responsive" width=486 height=657></amp-facebook>
-
-Embedding a post:
-
-    <%= amp_facebook("https://www.facebook.com/zuck/posts/10102593740125791", width: 486, height: 657) %>
-    # <amp-facebook data-href="https://www.facebook.com/zuck/posts/10102593740125791" layout="responsive" width=400 height=300></amp-facebook>
-
-Embedding a video:
-
-    <%= amp_facebook("https://www.facebook.com/zuck/posts/10102593740125791", type: "video", width: 486, height: 657 ) %>
-    # <amp-facebook data-href="https://www.facebook.com/zuck/posts/10102593740125791" data-embed-as="video" layout="responsive" width=400 height=300></amp-facebook>
-
-`amp_facebook` also takes a block:
-
-    <%= amp_facebook("https://www.facebook.com/zuck/posts/10102593740125791", width: 486, height: 657) do %>
-        <%= amp_placeholder("blockquote", class: "facebook-post") do %>
-            <p>The story how I became what some people would call a frontend engineer and an exploration into what that even means</p>
-        <% end %>
-    <% end %>
-
-**References:** [`amp_placeholder`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_placeholder.md)