Skip to content

Commit

Permalink
📖 Remove redundant "the examples below demonstrate" (#36878)
Browse files Browse the repository at this point in the history
A bunch of these even mentioned the wrong component!
  • Loading branch information
alanorozco committed Nov 10, 2021
1 parent c9b5dab commit 754815b
Show file tree
Hide file tree
Showing 22 changed files with 1 addition and 90 deletions.
8 changes: 1 addition & 7 deletions extensions/amp-accordion/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ Displays content sections that can be collapsed and expanded. This component pro

You must include each Bento component's required CSS library to guarantee proper loading and before adding custom styles. Or use the light-weight pre-upgrade styles available inline. See [Layout and style](#layout-and-style).

The examples below demonstrate use of the `<bento-accordion>` web component.

### Example: Import via npm

```sh
Expand All @@ -33,9 +31,6 @@ defineBentoAccordion();

### Example: Include via `<script>`

The example below contains an `bento-accordion` with three sections. The
`expanded` attribute on the third section expands it on page load.

<!--% example %-->

```html
Expand Down Expand Up @@ -75,6 +70,7 @@ The example below contains an `bento-accordion` with three sections. The
<h2>Section 2</h2>
<div>Content in section 2.</div>
</section>
<!-- Expanded on page load due to attribute: -->
<section expanded>
<h2>Section 3</h2>
<div>Content in section 3.</div>
Expand Down Expand Up @@ -407,8 +403,6 @@ Keep the following points in mind when you style an amp-accordion:

## Preact/React Component

The examples below demonstrates use of the `<BentoAccordion>` as a functional component usable with the Preact or React libraries.

### Example: Import via npm

```sh
Expand Down
4 changes: 0 additions & 4 deletions extensions/amp-base-carousel/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ The carousel advances between items if the user swipes or uses the customizable

You must include each Bento component's required CSS library to guarantee proper loading and before adding custom styles. Or use the light-weight pre-upgrade styles available inline. See [Layout and style](#layout-and-style).

The examples below demonstrate use of the `<bento-base-carousel>` web component.

### Example: Import via npm

```sh
Expand Down Expand Up @@ -394,8 +392,6 @@ example, you can recreate the default styling with the following HTML and CSS:

## Preact/React Component

The examples below demonstrate use of the `<BentoBaseCarousel>` as a functional component usable with the Preact or React libraries.

### Example: Import via npm

```sh
Expand Down
2 changes: 0 additions & 2 deletions extensions/amp-date-countdown/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ https://github.com/ampproject/amphtml/blob/422d171e87571c4d125a2bf956e78e92444c1

## Preact/React Component

The examples below demonstrates use of the `<BentoDateCountdown>` as a functional component usable with the Preact or React libraries.

### Example: Import via npm

```sh
Expand Down
2 changes: 0 additions & 2 deletions extensions/amp-date-display/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ https://github.com/ampproject/amphtml/blob/422d171e87571c4d125a2bf956e78e92444c1

## Preact/React Component

The examples below demonstrates use of the `<BentoDateDisplay>` as a functional component usable with the Preact or React libraries.

### Example: Import via npm

```sh
Expand Down
4 changes: 0 additions & 4 deletions extensions/amp-embedly-card/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ If you have a paid plan, use the `<bento-embedly-key>` or `<BentoEmbedlyContext.

You must include each Bento component's required CSS library to guarantee proper loading and before adding custom styles. Or use the light-weight pre-upgrade styles available inline. See [Layout and style](#layout-and-style).

The examples below demonstrate use of the `<bento-embedly-card>` web component.

### Example: Import via npm

```sh
Expand Down Expand Up @@ -199,8 +197,6 @@ Define a `title` attribute for the component to propagate to the underlying `<if

## Preact/React Component

The examples below demonstrate use of the `<BentoEmbedlyCard>` as a functional component usable with the Preact or React libraries.

### Example: Import via npm

```sh
Expand Down
2 changes: 0 additions & 2 deletions extensions/amp-facebook/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -482,8 +482,6 @@ Define a `title` attribute for the component to propagate to the underlying `<if

## Preact/React Component

The examples below demonstrate use of the `<BentoFacebook>` as a functional component usable with the Preact or React libraries.

### Example: Import via npm

```sh
Expand Down
4 changes: 0 additions & 4 deletions extensions/amp-fit-text/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ The expected content for Bento Fit Text is text or other inline content, but it

You must include each Bento component's required CSS library to guarantee proper loading and before adding custom styles. Or use the light-weight pre-upgrade styles available inline. See [Layout and style](#layout-and-style).

The examples below demonstrate use of the `<bento-fit-text>` web component.

### Example: Import via npm

```sh
Expand Down Expand Up @@ -155,8 +153,6 @@ Specifies the maximum font size in pixels as an integer that the `bento-fit-text

## Preact/React Component

The examples below demonstrate use of the `<BentoFitText>` as a functional component usable with the Preact or React libraries.

### Example: Import via npm

```sh
Expand Down
4 changes: 0 additions & 4 deletions extensions/amp-iframe/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ Renders an iframe that reports its position in the host document to the child wi

You must include each Bento component's required CSS library to guarantee proper loading and before adding custom styles. Or use the light-weight pre-upgrade styles available inline. See [Layout and style](#layout-and-style).

The examples below demonstrate use of the `<bento-iframe>` web component.

### Example: Import via npm

```sh
Expand Down Expand Up @@ -154,8 +152,6 @@ You may use the `bento-iframe` element selector to style the component.

## Preact/React Component

The examples below demonstrates use of the `<BentoIframe>` as a functional component usable with the Preact or React libraries.

### Example: Import via npm

```sh
Expand Down
6 changes: 0 additions & 6 deletions extensions/amp-inline-gallery/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ Its implementation uses a [Bento Base Carousel](https://www.npmjs.com/package/@b

You must include each Bento component's required CSS library to guarantee proper loading and before adding custom styles. Or use the light-weight pre-upgrade styles available inline. See [Layout and style](#layout-and-style).

The examples below demonstrate use of the `<bento-inline-gallery>` web component.

### Example: Import via npm

```sh
Expand All @@ -23,8 +21,6 @@ defineBentoInlineGallery();

### Example: Include via `<script>`

The example below contains a `bento-inline-gallery` consisting of three slides with thumbnails and a pagination indicator.

<!--% example %-->

```html
Expand Down Expand Up @@ -161,8 +157,6 @@ You may use the `bento-inline-gallery`, `bento-inline-gallery-pagination`, `bent

## Preact/React Component

The examples below demonstrates use of the `<BentoInlineGallery>` as a functional component usable with the Preact or React libraries.

### Example: Import via npm

```sh
Expand Down
4 changes: 0 additions & 4 deletions extensions/amp-instagram/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ Embeds an Instagram post.

You must include each Bento component's required CSS library before adding custom styles in order to guarantee proper loading. Or use the lightweight pre-uprgrade styles available inline. See [Layout and Style](#layout-and-style).

The examples below demonstrate use of the `<bento-instagram>` web component.

### Example: Import via npm

```sh
Expand Down Expand Up @@ -131,8 +129,6 @@ You may use the `bento-instagram` element selector to style the component.

## Preact/React Component

The examples below demonstrates use of the `<BentoInstagram>` as a functional component usable with the Preact or React libraries.

### Example: Import via npm

```sh
Expand Down
5 changes: 0 additions & 5 deletions extensions/amp-jwplayer/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ Displays a cloud-hosted JW Player in an iframe.

You must include each Bento component's required CSS library to guarantee proper loading and before adding custom styles. Or use the light-weight pre-upgrade styles available inline. See [Layout and style](#layout-and-style).

The examples below demonstrate use of the `<bento-jwplayer>` web component.

### Example: Import via npm

```sh
Expand All @@ -21,7 +19,6 @@ defineBentoJwplayer();

### Example: Include via `<script>`

The example below contains an `bento-jwplayer` with three sections. The
`expanded` attribute on the third section expands it on page load.

<!--% example %-->
Expand Down Expand Up @@ -231,8 +228,6 @@ You may use the `bento-jwplayer` element selector to style the accordion freely.

## Preact/React Component

The examples below demonstrates use of the `<BentoMathml>` as a functional component usable with the Preact or React libraries.

### Example: Import via npm

```sh
Expand Down
2 changes: 0 additions & 2 deletions extensions/amp-lightbox-gallery/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ When the user interacts with the element, a modal expands to fill the viewport u

You must include each Bento component's required CSS library to guarantee proper loading and before adding custom styles. As a web component

The examples below demonstrate use of the `<bento-lightbox-gallery>` web component.

### Example: Import via npm

```sh
Expand Down
4 changes: 0 additions & 4 deletions extensions/amp-lightbox/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ Displays any content in a full-viewport "lightbox" modal.

You must include each Bento component's required CSS library before adding custom styles in order to guarantee proper loading. Or use the lightweight pre-uprgrade styles available inline. See [Layout and Style](#layout-and-style).

The examples below demonstrate use of the `<bento-lightbox>` web component.

### Example: Import via npm

```sh
Expand Down Expand Up @@ -168,8 +166,6 @@ scroll when overflowing the height of the lightbox.

## Preact/React Component

The examples below demonstrates use of the `<BentoLightbox>` as a functional component usable with the Preact or React libraries.

### Example: Import via npm

```sh
Expand Down
7 changes: 0 additions & 7 deletions extensions/amp-mathml/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ Renders a MathML formula in an iframe.

You must include each Bento component's required CSS library to guarantee proper loading and before adding custom styles. Or use the light-weight pre-upgrade styles available inline. See [Layout and style](#layout-and-style).

The examples below demonstrate use of the `<bento-mathml>` web component.

### Example: Import via npm

```sh
Expand All @@ -21,9 +19,6 @@ defineBentoMathml();

### Example: Include via `<script>`

The example below contains an `bento-mathml` with three sections. The
`expanded` attribute on the third section expands it on page load.

<!--% example %-->

```html
Expand Down Expand Up @@ -146,8 +141,6 @@ You may use the `bento-mathml` element selector to style the accordion freely.

## Preact/React Component

The examples below demonstrates use of the `<BentoMathml>` as a functional component usable with the Preact or React libraries.

### Example: Import via npm

```sh
Expand Down
2 changes: 0 additions & 2 deletions extensions/amp-selector/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,6 @@ selector.addEventListener('select', (e) => console.log(e.data.targetOption));

## Preact/React Component

The examples below demonstrate use of the `<BentoSelector>` as a functional component usable with the Preact or React libraries.

### Example: Import via npm

```sh
Expand Down
4 changes: 0 additions & 4 deletions extensions/amp-sidebar/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ Provides a way to display meta content intended for temporary access such as nav

You must include each Bento component's required CSS library to guarantee proper loading and before adding custom styles. Or use the light-weight pre-upgrade styles available inline. See [Layout and style](#layout-and-style).

The examples below demonstrate use of the `<bento-sidebar>` web component.

### Example: Import via npm

```sh
Expand Down Expand Up @@ -181,8 +179,6 @@ This attribute is present when the sidebar is open.

## Preact/React Component

The examples below demonstrate use of the `<BentoSidebar>` as a functional component usable with the Preact or React libraries.

### Example: Import via npm

```sh
Expand Down
4 changes: 0 additions & 4 deletions extensions/amp-social-share/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ Currently, none of the buttons generated by Bento Social Share (including those

You must include each Bento component's required CSS library to guarantee proper loading and before adding custom styles. Or use the light-weight pre-upgrade styles available inline. See [Layout and style](#layout-and-style).

The examples below demonstrate use of the `<bento-social-share>` web component.

### Example: Import via npm

```sh
Expand Down Expand Up @@ -341,8 +339,6 @@ The description of the button for accessibility. A recommended label is "Share o

## Preact/React Component

The examples below demonstrate use of the `<BentoSocialShare>` as a functional component usable with the Preact or React libraries.

### Example: Import via npm

```sh
Expand Down
4 changes: 0 additions & 4 deletions extensions/amp-soundcloud/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ Embeds a [Soundcloud](https://soundcloud.com) clip.

You must include each Bento component's required CSS library to guarantee proper loading and before adding custom styles. Or use the light-weight pre-upgrade styles available inline. See [Layout and style](#layout-and-style).

The examples below demonstrate use of the `<bento-soundcloud>` web component.

### Example: Import via npm

```sh
Expand Down Expand Up @@ -150,8 +148,6 @@ The value for this attribute is the ID of a playlist, an integer.</td>

## Preact/React Component

The examples below demonstrate use of the `<BentoSoundcloud>` as a functional component usable with the Preact or React libraries.

### Example: Import via npm

```sh
Expand Down
7 changes: 0 additions & 7 deletions extensions/amp-stream-gallery/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ Use Bento Stream Gallery as a web component ([`<bento-stream-gallery>`](#web-com

You must include each Bento component's required CSS library to guarantee proper loading and before adding custom styles. Or use the light-weight pre-upgrade styles available inline. See [Layout and style](#layout-and-style).

The examples below demonstrate use of the `<bento-stream-gallery>` web component.

### Example: Import via npm

```sh
Expand All @@ -24,9 +22,6 @@ defineBentoStreamGallery();

### Example: Include via `<script>`

The example below contains an `bento-stream-gallery` with three sections. The
`expanded` attribute on the third section expands it on page load.

<!--% example %-->

```html
Expand Down Expand Up @@ -231,8 +226,6 @@ freely.

## Preact/React Component

The examples below demonstrates use of the `<BentoStreamGallery>` as a functional component usable with the Preact or React libraries.

### Example: Import via npm

```sh
Expand Down
4 changes: 0 additions & 4 deletions extensions/amp-timeago/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ Counts up to, or away from, a specified date and time. It replaces the text node

You must include each Bento component's required CSS library before adding custom styles in order to guarantee proper loading. Or use the lightweight pre-uprgrade styles available inline. See [Layout and Style](#layout-and-style).

The examples below demonstrate use of the `<bento-timeago>` web component.

### Example: Import via npm

```sh
Expand Down Expand Up @@ -174,8 +172,6 @@ Add the `cutoff` attribute to display the date specified in the `datatime` attri

## Preact/React Component

The examples below demonstrates use of the `<BentoTimeago>` as a functional component usable with the Preact or React libraries.

### Example: Import via npm

```sh
Expand Down
4 changes: 0 additions & 4 deletions extensions/amp-twitter/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ Embeds [Twitter](https://twitter.com) content like a Tweet or a Moment.

You must include each Bento component's required CSS library to guarantee proper loading and before adding custom styles. Or use the light-weight pre-upgrade styles available inline. See [Layout and style](#layout-and-style).

The examples below demonstrate use of the `<bento-twitter>` web component.

### Example: Import via npm

```sh
Expand Down Expand Up @@ -145,8 +143,6 @@ For details on the available options, see Twitter's docs <a href="https://develo

## Preact/React Component

The examples below demonstrate use of the `<BentoTwitter>` as a functional component usable with the Preact or React libraries.

### Example: Import via npm

```sh
Expand Down

0 comments on commit 754815b

Please sign in to comment.