Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename extension directories main .md files to README.md #1648

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,14 +86,14 @@ These components can:
such as [amp-img](builtins/amp-img.md) and [amp-video](builtins/amp-video.md).
* Implement embedded third-party content, such as
[amp-ad](builtins/amp-ad.md),
[amp-pinterest](extensions/amp-pinterest/amp-pinterest.md),
[amp-twitter](extensions/amp-twitter/amp-twitter.md),
and [amp-youtube](extensions/amp-youtube/amp-youtube.md).
[amp-pinterest](extensions/amp-pinterest/README.md),
[amp-twitter](extensions/amp-twitter/README.md),
and [amp-youtube](extensions/amp-youtube/README.md).
* Provide for common patterns in web pages,
such as [amp-lightbox](extensions/amp-lightbox/amp-lightbox.md)
and [amp-carousel](extensions/amp-carousel/amp-carousel.md).
such as [amp-lightbox](extensions/amp-lightbox/README.md)
and [amp-carousel](extensions/amp-carousel/README.md).
* Make advanced performance techniques easy,
such as [amp-anim](extensions/amp-anim/amp-anim.md),
such as [amp-anim](extensions/amp-anim/README.md),
which allows web developers to dynamically serve animated images
as either image files (GIF) or video files (WebM or MP4) based on browser compatibility.

Expand Down
2 changes: 1 addition & 1 deletion builtins/amp-ad.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Optional attribute to pass configuration to the ad as an arbitrarily complex JSO

##### data-consent-notification-id

Optional attribute. If provided will require confirming the [amp-user-notification](../extensions/amp-user-notification/amp-user-notification.md) with the given HTML-id until the "AMP client id" for the user (similar to a cookie) is passed to the ad. The means ad rendering is delayed until the user confirmed the notification.
Optional attribute. If provided will require confirming the [amp-user-notification](../extensions/amp-user-notification/README.md) with the given HTML-id until the "AMP client id" for the user (similar to a cookie) is passed to the ad. The means ad rendering is delayed until the user confirmed the notification.

#### Placeholder

Expand Down
10 changes: 5 additions & 5 deletions docs/include_features.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Make sure to review the documentation for each component individually as a refer
# Display an iframe

Display an iframe in your page using the
[`amp-iframe`](../extensions/amp-iframe/amp-iframe.md) element.
[`amp-iframe`](../extensions/amp-iframe/README.md) element.

`amp-iframe` requirements:

Expand Down Expand Up @@ -100,7 +100,7 @@ amp-img {
## Include an animated image

Include an animated image in your page
using the [`amp-anim`](../extensions/amp-anim/amp-anim.md) element.
using the [`amp-anim`](../extensions/amp-anim/README.md) element.

The `amp-anim` element is very similar to the `amp-img` element,
and provides additional functionality to manage loading and playing
Expand All @@ -125,7 +125,7 @@ The placeholder is specified via the `placeholder` attribute:
## Embed a Tweet

Embed a Twitter Tweet in your page
using the [`amp-twitter`](../extensions/amp-twitter/amp-twitter.md) element.
using the [`amp-twitter`](../extensions/amp-twitter/README.md) element.

To include a tweet in your page,
first include the following script to the `<head>`:
Expand Down Expand Up @@ -194,7 +194,7 @@ if the browser doesn't support HTML5 video, for example:
## Include a youtube video

Include a youtube video in your page
using the [`amp-youtube`](../extensions/amp-youtube/amp-youtube.md) element.
using the [`amp-youtube`](../extensions/amp-youtube/README.md) element.

You must include the following script in the `<head>`:

Expand All @@ -217,7 +217,7 @@ Use `layout="responsive"` to yield correct layouts for 16:9 aspect ratio videos:
## Include an audio resource

Include an audio resource in your page,
using the [`amp-audio`](../extensions/amp-audio/amp-audio.md) element.
using the [`amp-audio`](../extensions/amp-audio/README.md) element.

You must include the following script in the `<head>`:

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ when the document is first loaded, and each time an `<a>` tag is clicked:
```

- `data-consent-notification-id` Optional attribute. If provided will stop
processing the analytics request until a [amp-user-notification](../../extensions/amp-user-notification/amp-user-notification.md) with
processing the analytics request until a [amp-user-notification](../../extensions/amp-user-notification/README.md) with
the given HTML-id was confirmed by the user.

## Configuration
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
22 changes: 11 additions & 11 deletions spec/amp-html-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,17 +173,17 @@ In these cases, services may set up endpoints that produce data that conforms to
## Components

- [amp-img](../builtins/amp-img.md)
- [amp-audio](../extensions/amp-audio/amp-audio.md)
- [amp-anim](../extensions/amp-anim/amp-anim.md)
- [amp-audio](../extensions/amp-audio/README.md)
- [amp-anim](../extensions/amp-anim/README.md)
- [amp-ad](../builtins/amp-ad.md)
- [amp-pixel](../builtins/amp-pixel.md)
- [amp-video](../builtins/amp-video.md)
- [amp-brightcove](../extensions/amp-brightcove/amp-brightcove.md)
- [amp-carousel](../extensions/amp-carousel/amp-carousel.md)
- [amp-font](../extensions/amp-font/amp-font.md)
- [amp-lightbox](../extensions/amp-lightbox/amp-lightbox.md)
- [amp-iframe](../extensions/amp-iframe/amp-iframe.md)
- [amp-instagram](../extensions/amp-instagram/amp-instagram.md)
- [amp-twitter](../extensions/amp-twitter/amp-twitter.md)
- [amp-vine](../extensions/amp-vine/amp-vine.md)
- [amp-youtube](../extensions/amp-youtube/amp-youtube.md)
- [amp-brightcove](../extensions/amp-brightcove/README.md)
- [amp-carousel](../extensions/amp-carousel/README.md)
- [amp-font](../extensions/amp-font/README.md)
- [amp-lightbox](../extensions/amp-lightbox/README.md)
- [amp-iframe](../extensions/amp-iframe/README.md)
- [amp-instagram](../extensions/amp-instagram/README.md)
- [amp-twitter](../extensions/amp-twitter/README.md)
- [amp-vine](../extensions/amp-vine/README.md)
- [amp-youtube](../extensions/amp-youtube/README.md)
2 changes: 1 addition & 1 deletion spec/amp-iframe-origin-policy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Iframe origin policy

Various AMP features allow loading iframes from arbitrary origins into AMP pages. Examples are the [`amp-iframe`](../extensions/amp-iframe/amp-iframe.md) element and [the custom domain feature of `amp-ad`](../builtins/amp-ad.md#running-ads-from-a-custom-domain). The origin of a URL such as `https://example.com/some/path` is `https://example.com`. See [the HTML5 spec](https://www.w3.org/TR/2011/WD-html5-20110525/origin-0.html#origin) for details.
Various AMP features allow loading iframes from arbitrary origins into AMP pages. Examples are the [`amp-iframe`](../extensions/amp-iframe/README.md) element and [the custom domain feature of `amp-ad`](../builtins/amp-ad.md#running-ads-from-a-custom-domain). The origin of a URL such as `https://example.com/some/path` is `https://example.com`. See [the HTML5 spec](https://www.w3.org/TR/2011/WD-html5-20110525/origin-0.html#origin) for details.

These iframes are typically allowed to execute arbitrary JavaScript, but for security reasons they are never allowed to access the AMP document itself using any method besides sending messages via postMessage.

Expand Down
2 changes: 1 addition & 1 deletion spec/amp-var-substitutions.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ limitations under the License.
## Overview

Some components such as [`amp-pixel`](../builtins/amp-pixel.md) and
[`amp-list`](../extensions/amp-list/amp-list.md) allow variables to be substituted
[`amp-list`](../extensions/amp-list/README.md) allow variables to be substituted
in the relevant URLs. AMP provides a number of standard variable substitutions and
allows each component to add their own. The rest of this document talks about
the variables supported by the platform.
Expand Down
2 changes: 1 addition & 1 deletion validator/testdata/feature_tests/amp_brightcove.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<!--
Test Description:
Tests support for the amp-brightcove tag.
https://github.com/ampproject/amphtml/blob/master/extensions/amp-brightcove/amp-brightcove.md
https://github.com/ampproject/amphtml/blob/master/extensions/amp-brightcove/README.md
-->
<!doctype html>
<html ⚡>
Expand Down
4 changes: 2 additions & 2 deletions validator/testdata/feature_tests/amp_brightcove.out
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
FAIL
feature_tests/amp_brightcove.html:46:2 The mandatory attribute 'data-account' is missing in tag 'amp-brightcove'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-brightcove/amp-brightcove.md)
feature_tests/amp_brightcove.html:50:7 The 'amp-brightcove extension .js script' tag is missing or incorrect, but required by 'amp-brightcove'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-brightcove/amp-brightcove.md)
feature_tests/amp_brightcove.html:46:2 The mandatory attribute 'data-account' is missing in tag 'amp-brightcove'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-brightcove/README.md)
feature_tests/amp_brightcove.html:50:7 The 'amp-brightcove extension .js script' tag is missing or incorrect, but required by 'amp-brightcove'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-brightcove/README.md)
2 changes: 1 addition & 1 deletion validator/testdata/feature_tests/amp_facebook.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<!--
Test Description:
Tests support for the amp-facebook tag.
https://github.com/ampproject/amphtml/blob/master/extensions/amp-facebook/amp-facebook.md
https://github.com/ampproject/amphtml/blob/master/extensions/amp-facebook/README.md
-->
<!doctype html>
<html ⚡>
Expand Down
2 changes: 1 addition & 1 deletion validator/testdata/feature_tests/amp_font.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<!--
Test Description:
Tests support for the amp-font tag.
https://github.com/ampproject/amphtml/blob/master/extensions/amp-font/amp-font.md
https://github.com/ampproject/amphtml/blob/master/extensions/amp-font/README.md
-->
<amp-font
layout="nodisplay"
Expand Down
8 changes: 4 additions & 4 deletions validator/testdata/feature_tests/amp_list.out
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
FAIL
feature_tests/amp_list.html:36:2 The attribute 'wdith' may not appear in tag 'amp-list'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-list/amp-list.md)
feature_tests/amp_list.html:41:2 The mandatory attribute 'src' is missing in tag 'amp-list'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-list/amp-list.md)
feature_tests/amp_list.html:46:2 The implied layout 'CONTAINER' is not supported by tag 'amp-list'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-list/amp-list.md)
feature_tests/amp_list.html:50:7 The 'amp-list extension .js script' tag is missing or incorrect, but required by 'amp-list'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-list/amp-list.md)
feature_tests/amp_list.html:36:2 The attribute 'wdith' may not appear in tag 'amp-list'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-list/README.md)
feature_tests/amp_list.html:41:2 The mandatory attribute 'src' is missing in tag 'amp-list'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-list/README.md)
feature_tests/amp_list.html:46:2 The implied layout 'CONTAINER' is not supported by tag 'amp-list'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-list/README.md)
feature_tests/amp_list.html:50:7 The 'amp-list extension .js script' tag is missing or incorrect, but required by 'amp-list'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-list/README.md)
2 changes: 1 addition & 1 deletion validator/testdata/feature_tests/amp_pinterest.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<!--
Test Description:
Tests support for the amp-pinterest tag.
https://github.com/ampproject/amphtml/blob/master/extensions/amp-pinterest/amp-pinterest.md
https://github.com/ampproject/amphtml/blob/master/extensions/amp-pinterest/README.md
-->
<!doctype html>
<html ⚡>
Expand Down
12 changes: 6 additions & 6 deletions validator/testdata/feature_tests/amp_user_notification.out
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
FAIL
feature_tests/amp_user_notification.html:41:2 The mandatory attribute 'data-show-if-href' is missing in tag 'amp-user-notification'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-user-notification/amp-user-notification.md)
feature_tests/amp_user_notification.html:50:2 The mandatory attribute 'data-dismiss-href' is missing in tag 'amp-user-notification'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-user-notification/amp-user-notification.md)
feature_tests/amp_user_notification.html:59:2 The mandatory attribute 'data-show-if-href' is missing in tag 'amp-user-notification'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-user-notification/amp-user-notification.md)
feature_tests/amp_user_notification.html:59:2 The mandatory attribute 'data-dismiss-href' is missing in tag 'amp-user-notification'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-user-notification/amp-user-notification.md)
feature_tests/amp_user_notification.html:67:2 The specified layout 'CONTAINER' is not supported by tag 'amp-user-notification'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-user-notification/amp-user-notification.md)
feature_tests/amp_user_notification.html:77:7 The 'amp-user-notification extension .js script' tag is missing or incorrect, but required by 'amp-user-notification'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-user-notification/amp-user-notification.md)
feature_tests/amp_user_notification.html:41:2 The mandatory attribute 'data-show-if-href' is missing in tag 'amp-user-notification'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-user-notification/README.md)
feature_tests/amp_user_notification.html:50:2 The mandatory attribute 'data-dismiss-href' is missing in tag 'amp-user-notification'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-user-notification/README.md)
feature_tests/amp_user_notification.html:59:2 The mandatory attribute 'data-show-if-href' is missing in tag 'amp-user-notification'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-user-notification/README.md)
feature_tests/amp_user_notification.html:59:2 The mandatory attribute 'data-dismiss-href' is missing in tag 'amp-user-notification'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-user-notification/README.md)
feature_tests/amp_user_notification.html:67:2 The specified layout 'CONTAINER' is not supported by tag 'amp-user-notification'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-user-notification/README.md)
feature_tests/amp_user_notification.html:77:7 The 'amp-user-notification extension .js script' tag is missing or incorrect, but required by 'amp-user-notification'. (see https://github.com/ampproject/amphtml/blob/master/extensions/amp-user-notification/README.md)
Loading