RubyGems - amp-html - Versions diffs - 0.7.7 - Mend

amp-html 0.7.7

Files changed (191) hide show

checksums.yaml +7 -0
data/.github/issue_template.md +16 -0
data/.github/pull_request_template.md +21 -0
data/.gitignore +13 -0
data/.travis.yml +4 -0
data/CHANGELOG.md +302 -0
data/CONTRIBUTING.md +1 -0
data/DEPRECATIONS.md +9 -0
data/Gemfile +12 -0
data/Gemfile.lock +162 -0
data/INSTALL.md +1 -0
data/LICENSE +21 -0
data/OWNERS.yaml +1 -0
data/README.md +192 -0
data/Rakefile +6 -0
data/amp-html.gemspec +29 -0
data/bin/amp-html +4 -0
data/lib/amp_html.rb +27 -0
data/lib/amp_html/cli.rb +113 -0
data/lib/amp_html/components/docs/README.md +101 -0
data/lib/amp_html/components/docs/ad.md +83 -0
data/lib/amp_html/components/docs/analytics.md +131 -0
data/lib/amp_html/components/docs/anim.md +66 -0
data/lib/amp_html/components/docs/fonts.md +63 -0
data/lib/amp_html/components/docs/forms.md +79 -0
data/lib/amp_html/components/docs/iframe.md +62 -0
data/lib/amp_html/components/docs/javascript.md +71 -0
data/lib/amp_html/components/docs/lists.md +168 -0
data/lib/amp_html/components/docs/media.md +52 -0
data/lib/amp_html/components/docs/mustache.md +46 -0
data/lib/amp_html/components/docs/notifications.md +0 -0
data/lib/amp_html/components/docs/schema.md +80 -0
data/lib/amp_html/components/docs/service_worker.md +60 -0
data/lib/amp_html/components/docs/social.md +130 -0
data/lib/amp_html/components/docs/stylesheets.md +50 -0
data/lib/amp_html/components/help.rb +19 -0
data/lib/amp_html/components/install.rb +34 -0
data/lib/amp_html/components/templates/ERROR.md +5 -0
data/lib/amp_html/components/templates/README.md +12 -0
data/lib/amp_html/configuration.rb +170 -0
data/lib/amp_html/configuration/docs/README.md +0 -0
data/lib/amp_html/configuration/help.rb +11 -0
data/lib/amp_html/helpers/docs/README.md +98 -0
data/lib/amp_html/helpers/docs/amp.md +0 -0
data/lib/amp_html/helpers/docs/amp_ad.md +86 -0
data/lib/amp_html/helpers/docs/amp_analytics.md +76 -0
data/lib/amp_html/helpers/docs/amp_anim.md +68 -0
data/lib/amp_html/helpers/docs/amp_audio.md +54 -0
data/lib/amp_html/helpers/docs/amp_auto_ads.md +43 -0
data/lib/amp_html/helpers/docs/amp_close_user_notification_button.md +0 -0
data/lib/amp_html/helpers/docs/amp_css.md +37 -0
data/lib/amp_html/helpers/docs/amp_css_link.md +0 -0
data/lib/amp_html/helpers/docs/amp_custom_ad.md +0 -0
data/lib/amp_html/helpers/docs/amp_document_link.md +0 -0
data/lib/amp_html/helpers/docs/amp_embed.md +86 -0
data/lib/amp_html/helpers/docs/amp_facebook.md +70 -0
data/lib/amp_html/helpers/docs/amp_fallback.md +47 -0
data/lib/amp_html/helpers/docs/amp_font.md +0 -0
data/lib/amp_html/helpers/docs/amp_font_link.md +0 -0
data/lib/amp_html/helpers/docs/amp_form.md +0 -0
data/lib/amp_html/helpers/docs/amp_form_response.md +0 -0
data/lib/amp_html/helpers/docs/amp_gfycat.md +0 -0
data/lib/amp_html/helpers/docs/amp_global_css.md +0 -0
data/lib/amp_html/helpers/docs/amp_google_analytics.md +0 -0
data/lib/amp_html/helpers/docs/amp_google_font.md +0 -0
data/lib/amp_html/helpers/docs/amp_head.md +0 -0
data/lib/amp_html/helpers/docs/amp_html_doctype.md +0 -0
data/lib/amp_html/helpers/docs/amp_iframe.md +0 -0
data/lib/amp_html/helpers/docs/amp_image.md +0 -0
data/lib/amp_html/helpers/docs/amp_input.md +0 -0
data/lib/amp_html/helpers/docs/amp_instagram.md +0 -0
data/lib/amp_html/helpers/docs/amp_js.md +0 -0
data/lib/amp_html/helpers/docs/amp_link.md +0 -0
data/lib/amp_html/helpers/docs/amp_list.md +0 -0
data/lib/amp_html/helpers/docs/amp_live_list.md +0 -0
data/lib/amp_html/helpers/docs/amp_live_list_items.md +0 -0
data/lib/amp_html/helpers/docs/amp_live_list_pagination.md +0 -0
data/lib/amp_html/helpers/docs/amp_live_list_update.md +0 -0
data/lib/amp_html/helpers/docs/amp_mustache.md +0 -0
data/lib/amp_html/helpers/docs/amp_pin_it.md +0 -0
data/lib/amp_html/helpers/docs/amp_pin_widget.md +0 -0
data/lib/amp_html/helpers/docs/amp_pinterest_follow.md +0 -0
data/lib/amp_html/helpers/docs/amp_pixel.md +0 -0
data/lib/amp_html/helpers/docs/amp_placeholder.md +0 -0
data/lib/amp_html/helpers/docs/amp_reddit.md +0 -0
data/lib/amp_html/helpers/docs/amp_resources.md +0 -0
data/lib/amp_html/helpers/docs/amp_selector.md +0 -0
data/lib/amp_html/helpers/docs/amp_serviceworker.md +0 -0
data/lib/amp_html/helpers/docs/amp_social_share.md +0 -0
data/lib/amp_html/helpers/docs/amp_soundcloud.md +0 -0
data/lib/amp_html/helpers/docs/amp_twitter.md +0 -0
data/lib/amp_html/helpers/docs/amp_user_notification.md +0 -0
data/lib/amp_html/helpers/docs/amp_video.md +0 -0
data/lib/amp_html/helpers/docs/amp_video_ad.md +0 -0
data/lib/amp_html/helpers/docs/amp_vine.md +0 -0
data/lib/amp_html/helpers/docs/amp_youtube.md +0 -0
data/lib/amp_html/helpers/docs/audio_tag.md +0 -0
data/lib/amp_html/helpers/docs/canonical_document_link.md +0 -0
data/lib/amp_html/helpers/docs/form_tag.md +0 -0
data/lib/amp_html/helpers/docs/image_tag.md +0 -0
data/lib/amp_html/helpers/docs/input_tag.md +0 -0
data/lib/amp_html/helpers/docs/javascript_include_tag.md +0 -0
data/lib/amp_html/helpers/docs/noscript_tag.md +0 -0
data/lib/amp_html/helpers/docs/schema_tag.md +0 -0
data/lib/amp_html/helpers/docs/stylesheet_link_tag.md +0 -0
data/lib/amp_html/helpers/docs/video_tag.md +0 -0
data/lib/amp_html/helpers/help.rb +23 -0
data/lib/amp_html/root.rb +7 -0
data/lib/amp_html/test.rb +169 -0
data/lib/amp_html/test/help.rb +11 -0
data/lib/amp_html/test/templates/README.md +43 -0
data/lib/amp_html/test/templates/css/!important.md +1 -0
data/lib/amp_html/test/templates/css/-amp-.md +1 -0
data/lib/amp_html/test/templates/css/-moz-binding.md +1 -0
data/lib/amp_html/test/templates/css/@import.md +1 -0
data/lib/amp_html/test/templates/css/behavior.md +1 -0
data/lib/amp_html/test/templates/css/filter.md +1 -0
data/lib/amp_html/test/templates/css/i-amp-.md +1 -0
data/lib/amp_html/test/templates/css/overflow.md +1 -0
data/lib/amp_html/test/templates/html/applet.md +1 -0
data/lib/amp_html/test/templates/html/audio.md +1 -0
data/lib/amp_html/test/templates/html/base.md +1 -0
data/lib/amp_html/test/templates/html/embed.md +1 -0
data/lib/amp_html/test/templates/html/frame.md +1 -0
data/lib/amp_html/test/templates/html/frameset.md +1 -0
data/lib/amp_html/test/templates/html/http-equiv.md +1 -0
data/lib/amp_html/test/templates/html/iframe.md +1 -0
data/lib/amp_html/test/templates/html/img.md +1 -0
data/lib/amp_html/test/templates/html/javascript_include_tag.md +1 -0
data/lib/amp_html/test/templates/html/object.md +1 -0
data/lib/amp_html/test/templates/html/onclick.md +1 -0
data/lib/amp_html/test/templates/html/onmousehover.md +1 -0
data/lib/amp_html/test/templates/html/param.md +1 -0
data/lib/amp_html/test/templates/html/stylesheet_link_tag.md +1 -0
data/lib/amp_html/test/templates/html/video.md +1 -0
data/lib/amp_html/test/templates/markup/!doctype.md +1 -0
data/lib/amp_html/test/templates/markup/amp_document_link.md +1 -0
data/lib/amp_html/test/templates/markup/amp_head.md +1 -0
data/lib/amp_html/test/templates/markup/amp_html_doctype.md +1 -0
data/lib/amp_html/test/templates/markup/canonical_document_link.md +1 -0
data/lib/amp_html/test/templates/markup/head_body.md +1 -0
data/lib/amp_html/test/templates/markup/html.md +1 -0
data/lib/amp_html/test/templates/markup/meta_viewport.md +1 -0
data/lib/amp_html/validate.rb +46 -0
data/lib/amp_html/validate/help.rb +11 -0
data/lib/amp_html/validate/templates/README.md +32 -0
data/lib/amp_html/version.rb +13 -0
data/lib/generators/amphtml/assets_generator.rb +31 -0
data/lib/generators/amphtml/bundle_generator.rb +50 -0
data/lib/generators/amphtml/components_generator.rb +84 -0
data/lib/generators/amphtml/helpers_generator.rb +32 -0
data/lib/generators/amphtml/install_generator.rb +53 -0
data/lib/generators/amphtml/views_generator.rb +62 -0
data/lib/generators/templates/assets/README.md +0 -0
data/lib/generators/templates/assets/stylesheets/application.scss +15 -0
data/lib/generators/templates/components/README.md +0 -0
data/lib/generators/templates/components/assets/javascripts/application.js +15 -0
data/lib/generators/templates/components/helpers/ad_tag_helper.rb +83 -0
data/lib/generators/templates/components/helpers/analytics_tag_helper.rb +30 -0
data/lib/generators/templates/components/helpers/anim_tag_helper.rb +42 -0
data/lib/generators/templates/components/helpers/iframe_tag_helper.rb +27 -0
data/lib/generators/templates/components/helpers/javascript_tag_helper.rb +12 -0
data/lib/generators/templates/components/helpers/lists_tag_helper.rb +82 -0
data/lib/generators/templates/components/helpers/notification_tag_helper.rb +16 -0
data/lib/generators/templates/components/helpers/serviceworker_tag_helper.rb +15 -0
data/lib/generators/templates/components/helpers/social_tag_helper.rb +228 -0
data/lib/generators/templates/components/public/remote.html +28 -0
data/lib/generators/templates/components/views/_components.html.erb +141 -0
data/lib/generators/templates/components/views/_google_analytics.html.erb +23 -0
data/lib/generators/templates/helpers/README.md +1 -0
data/lib/generators/templates/helpers/amp/fallback_tag_helper.rb +16 -0
data/lib/generators/templates/helpers/amp/font_tag_helper.rb +37 -0
data/lib/generators/templates/helpers/amp/link_tag_helper.rb +11 -0
data/lib/generators/templates/helpers/amp/mustache_tag_helper.rb +13 -0
data/lib/generators/templates/helpers/amp/noscript_tag_helper.rb +13 -0
data/lib/generators/templates/helpers/amp/placeholder_tag_helper.rb +16 -0
data/lib/generators/templates/helpers/amp/schema_tag_helper.rb +16 -0
data/lib/generators/templates/helpers/amp/stylesheets_tag_helper.rb +21 -0
data/lib/generators/templates/helpers/amp_tag_helper.rb.erb +65 -0
data/lib/generators/templates/helpers/asset_tag_helper.rb.erb +119 -0
data/lib/generators/templates/helpers/form_tag_helper.rb.erb +79 -0
data/lib/generators/templates/install/README.md +1 -0
data/lib/generators/templates/install/amphtml.rb.erb +19 -0
data/lib/generators/templates/install/amphtml.yml.erb +189 -0
data/lib/generators/templates/views/README.md +1 -0
data/lib/generators/templates/views/application.html.erb +71 -0
data/lib/generators/templates/views/application/_head.html.erb +47 -0
data/lib/generators/templates/views/application/_resources.html.erb +16 -0
data/lib/generators/templates/views/application/_schema.html.erb +6 -0
data/lib/generators/templates/views/config/mime_types.rb +8 -0
metadata +294 -0

data/lib/amp_html/components/docs/javascript.md ADDED

@@ -0,0 +1,71 @@
+# [Components](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs) / Javascript BETA
+## Information
+The AMP-HTML Javascript Component allows the use of javascript assets in AMP documents.
+---
+### Quick info
+#### Latest component release: 0.6.0 (Pre-release) - 2017-03-19
+[**Changelog for version 0.6.0**](https://github.com/slooob/amp-html/blob/master/CHANGELOG.md#060-pre-release---2017-03-19)
+#### Requirements
+The Javascript Component depends on the [AMP-HTML Iframe Component](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs/iframe.md).
+#### Dependents
+No other components depend on the Javascript Component.
+#### [DeepIntegration](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs#deepintegration-components): Disabled
+#### [Availability](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs#availability-of-components): Installable
+---
+## Installation
+Run in the command line:
+    amp-html install javascript
+Now you are ready to use the Javascript Component.
+To learn more about this component, without opening the documentation, run:
+    amp-html component javascript
+## Configuration
+In your AMP-HTML configuration (`config/amp-html.yml`) search for the section of the Assets Configuration.
+There you can specify whether javascript-assets outside of the `assets/#{type}/amp` are precompiled or not:
+    only_amp: true
+If you set it to `true`, only assets inside the amp directory are precompiled. It defaults to `true`. If SplitView is enabled it defaults to `false`.
+## Usage
+By default every javascript (`.js`) file inside of your `app/assets/javascripts/amp` (depending on your AMP-HTML configuration) directory is included in your application layout.
+You can include some external javascript utilizing the `amp_js` helper in your `<head>` tag:
+    <%= amp_js(source) %>
+    <%= amp_js("https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js") %>
+For a detailed reference on the `amp_js` helper, follow the link below.
+### Helpers
+The following helpers are usable with the Javascript Component of AMP-HTML
+* [`amp_js`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_js.md)

data/lib/amp_html/components/docs/lists.md ADDED

@@ -0,0 +1,168 @@
+# [Components](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs) / Lists BETA
+## Information
+The AMP-HTML Lists Component allows to dynamically from a CORS JSON endpoint.
+---
+### Quick info
+#### Latest component release: 0.7.3 (Pre-release) - 2017-03-22
+[**Changelog for version 0.7.3**](https://github.com/slooob/amp-html/blob/master/CHANGELOG.md#073-pre-release---2017-03-22)
+#### Requirements
+The Lists Component does not depend on any other components.
+#### Dependents
+No other components depend on the Lists Component.
+#### [DeepIntegration](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs#deepintegration-components): Disabled
+#### [Availability](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs#availability-of-components): Installable
+---
+## Installation
+Run in the command line:
+    amp-html install lists
+Now you are ready to use the Lists Component.
+To learn more about this component, without opening the documentation, run:
+    amp-html component lists
+## Usage
+In your views you can implement a list as follows:
+    <%= amp_list(source, options) do %>
+    <% end %>
+    <%= amp_list("https://data.com/articles.json?ref=CANONICAL_URL", width: 300, height: 200) do %>
+        <%= amp_mustache do %>
+            <div>
+                <%= amp_image("{{imageUrl}}", width: 50, height:50) %>
+                {{title}}
+            </div>
+        <% end %>
+        <div overflow role=button aria-label="Show more" class="list-overflow">
+            Show more
+        </div>
+    <% end %>
+**Note:** The `amp_list` defaults to `layout: "responsive"`.
+Learn more about the `amp_list` helper in the dedicated reference linked below.
+**References:** [`amp_mustache`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_mustache.md), [`amp_image`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_image.md)
+### Live Lists
+By using `amp_live_list` you can update the content in the client as new content is available:
+    <%= amp_live_list(id, max_items_per_page, interval) do %>
+    <% end %>
+    <%= amp_css do %>
+        amp-live-list > [update] {
+            display: none;
+        }
+        #fixed-button {
+            position: fixed;
+            top: 10px;
+            left: 50%;
+            transform: translateX(-50%)
+        }
+        .slide.amp-active {
+            overflow-y: hidden;
+            height: 100px;
+            max-height: 150px;
+            transition-property: height;
+            transition-duration: .2s;
+            transition-timing-function: ease-in;
+            background: #3f51b5;
+        }
+        .slide.amp-hidden {
+            max-height: 0;
+        }
+        // We need to override "display: none" to be able to see
+        // the transition effect on the 2nd live list.
+        #live-list-2 > .amp-hidden[update] {
+            display: block;
+        }
+    <% end %>
+    <%= amp_live_list("live-list-1", "5", "16000") do %>
+        <%= amp_live_list_update(ontap: "live-list-1.update", id: "fixed-button", class: "button") do %>
+            new updates on live list 1
+        <% end %>
+        <%= amp_live_list_items do %>
+            <div id="live-list-1-item-2" data-sort-time="1462814963592">
+                <div class="card">
+                    <div class="logo">
+                        <%= amp_image("ampicon.png", layout: "fixed", height: "50", width: "50") %>
+                    </div>
+                </div>
+            </div>
+            <div id="live-list-1-item-1" data-sort-time="1462814955597">
+                <div class="card">
+                    <div class="logo">
+                        <%= amp_image("ampicon.png", layout: "fixed", height: "50", width: "50") %>
+                    </div>
+                </div>
+            </div>
+        <% end %>
+    <% end %>
+    <%= amp_live_list("live-list-2", "10", "20000") do %>
+        <%= amp_live_list_update("button", "live-list-1", id: "fixed-button", class: "button") do %>
+            new updates on live list 1
+        <% end %>
+        <%= amp_live_list_items do %>
+            <div id="live-list-1-item-2" data-sort-time="1462814963592">
+                <div class="card">
+                    <div class="logo">
+                        <%= amp_image("ampicon.png", layout: "fixed", height: "50", width: "50") %>
+                    </div>
+                </div>
+            </div>
+            <div id="live-list-1-item-1" data-sort-time="1462814955597">
+                <div class="card">
+                    <div class="logo">
+                        <%= amp_image("ampicon.png", layout: "fixed", height: "50", width: "50") %>
+                    </div>
+                </div>
+            </div>
+        <% end %>
+    <% end %>
+**Note:** The `amp_live_list` defaults to `layout: "responsive"`.
+Learn more about the `amp_live_list` helper in the dedicated reference linked below.
+**References:** [`amp_css`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_css.md), [`amp_image`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_image.md)
+### Helpers
+The following helpers are usable with the Lists Component of AMP-HTML
+* [`amp_list`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_list.md)
+* [`amp_live_list`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_live_list.md)
+* [`amp_live_list_update`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_live_list_update.md)
+* [`amp_live_list_items`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_live_list_items.md)
+* [`amp_live_list_pagination`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_live_list_pagination.md)

data/lib/amp_html/components/docs/media.md ADDED

@@ -0,0 +1,52 @@
+# [Components](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs) / Media BETA
+## Information
+The AMP-HTML Media Component allows to use HTML5-similar media tags in AMP documents.
+---
+### Quick info
+#### Latest component release: 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)
+#### Requirements
+The Media Component does not depend on any other components.
+#### Dependents
+No other components depend on the Media Component.
+#### [DeepIntegration](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs#deepintegration-components): Disabled
+#### [Availability](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs#availability-of-components): Build-in
+---
+## Usage
+In your views you include an image as follows:
+    <%= amp_image(source, options) %>
+    <%= amp_image("my_image.png", size: "400x300", alt: "My Image") %>
+**Note:** The `amp_image` helper uses the assets pipeline to find your image source.
+Learn more about the `amp_image` helper in the dedicated reference linked below.
+### Helpers
+The following helpers are usable with the Media Component of AMP-HTML
+* [`amp_image`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_image.md)
+* [`amp_video`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_video.md)
+* [`amp_audio`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_audio.md)
+* [`image_tag`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/image_tag.md)
+* [`video_tag`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/video_tag.md)
+* [`audio_tag`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/audio_tag.md)

data/lib/amp_html/components/docs/mustache.md ADDED

@@ -0,0 +1,46 @@
+# [Components](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs) / Mustache.js
+## Information
+The AMP-HTML Mustache.js Component allows rendering of templates with `{{mustaches}}`.
+---
+### Quick info
+#### Latest component release: 0.7.3 (Pre-release) - 2017-03-22
+[**Changelog for version 0.7.3**](https://github.com/slooob/amp-html/blob/master/CHANGELOG.md#073-pre-release---2017-03-22)
+#### Requirements
+The Mustache.js Component does not depend on any other components.
+#### Dependents
+The [AMP-HTML Forms Component](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs/forms.md) depends on the Mustache.js Component.
+#### [DeepIntegration](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs#deepintegration-components): Disabled
+#### [Availability](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs#availability-of-components): Build-in
+---
+## Usage
+In your views you can create a Mustache.js template as follows:
+    <%= amp_mustache do %>
+        Hello {{world}}!
+    <% end %>
+Learn more about the `amp_mustache` helper in the dedicated reference linked below.
+### Helpers
+The following helpers are usable with the Mustache.js Component of AMP-HTML
+* [`amp_mustache`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_mustache.md)

data/lib/amp_html/components/docs/notifications.md ADDED

File without changes

data/lib/amp_html/components/docs/schema.md ADDED

@@ -0,0 +1,80 @@
+# [Components](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs) / Schema.org
+## Information
+The AMP-HTML Schema.org Component allows to easily include a Schema.org definition to get your content distributed in certain places, like the Google News Carousel.
+---
+### Quick info
+#### Latest component release: 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)
+#### Requirements
+The Schema.org Component does not depend on any other components.
+#### Dependents
+No other components depend on the Schema.org Component.
+#### [DeepIntegration](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs#deepintegration-components): Enabled
+#### [Availability](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs#availability-of-components): Build-in
+---
+## Configuration
+In your AMP-HTML configuration (`config/amp-html.yml`) search for the section of the App Customization.
+There you can specify some information about your app:
+    name: "MyApp"
+    type: "Organization"
+    date_published: "2015-10-07T12:02:41Z"
+    image: ["logo.jpg"]
+You can override each of these values by passing a different value to the `schema_tag`.
+## Usage
+In your views you can setup analytics as follows:
+    <%= schema_tag %>
+By default it takes the configured values in your AMP-HTML configuration:
+    <script type="application/ld+json">
+    {
+        "@context": "http://schema.org",
+        "@type": "Organization",
+        "headline": "MyApp",
+        "datePublished": "2015-10-07T12:02:41Z",
+        "image": [
+            "logo.jpg"
+        ]
+    }
+    </script>
+You can override values:
+    <%= schema_tag(headline: "Open-source framework for publishing content", type: "NewsArticle", image: ["cover.jpg"]) %>
+You can also add new information:
+    <%= schema_tag(address: "PO Box 7775, San Francisco", email: "email@example.com") %>
+Learn more about the `schema_tag` helper in the dedicated reference linked below.
+### Helpers
+The following helpers are usable with the Schema.org Component of AMP-HTML
+* [`schema_tag`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/schema_tag.md)

data/lib/amp_html/components/docs/service_worker.md ADDED

@@ -0,0 +1,60 @@
+# [Components](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs) / Service Worker BETA
+## Information
+The AMP-HTML Service Worker Component allows to install [ServiceWorker](https://developers.google.com/web/fundamentals/getting-started/primers/service-workers)'s in AMP documents.
+---
+### Quick info
+#### Latest component release: 0.7.2 (Pre-release) - 2017-03-22
+[**Changelog for version 0.7.2**](https://github.com/slooob/amp-html/blob/master/CHANGELOG.md#072-pre-release---2017-03-22)
+#### Requirements
+The Service Worker Component does not depend on any other components.
+#### Dependents
+No other components depend on the Service Worker Component.
+#### [DeepIntegration](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs#deepintegration-components): Disabled
+#### [Availability](https://github.com/slooob/amp-html/tree/master/lib/amp-html/components/docs#availability-of-components): Installable
+---
+## Installation
+Run in the command line:
+    amp-html install service_worker
+Now you are ready to use the Service Worker Component.
+To learn more about this component, without opening the documentation, run:
+    amp-html component service_worker
+## Usage
+In your views you can implement a ServiceWorker as follows:
+    <%= amp_serviceworker(register_url, install_url, options) %>
+    <%= amp_anim("https://www.your-domain.com/serviceworker.js", "https://www.your-domain.com/install-serviceworker.html") %>
+Learn more about the `amp_serviceworker` helper in the dedicated reference linked below.
+**References:** [`amp_placeholder`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_placeholder.md)
+### Helpers
+The following helpers are usable with the Service Worker Component of AMP-HTML
+* [`amp_serviceworker`](https://github.com/slooob/amp-html/blob/master/lib/amp-html/helpers/docs/amp_serviceworker.md)