Skip to content

Commit

Permalink
📕 Remove Example: prefix from bento import docs (#36915)
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastianbenz committed Nov 15, 2021
1 parent e69fe70 commit 9dc8f18
Show file tree
Hide file tree
Showing 22 changed files with 45 additions and 45 deletions.
4 changes: 2 additions & 2 deletions extensions/amp-accordion/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ 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).

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/accordion
Expand Down Expand Up @@ -414,7 +414,7 @@ Keep the following points in mind when you style an amp-accordion:

## Preact/React Component

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/accordion
Expand Down
4 changes: 2 additions & 2 deletions extensions/amp-base-carousel/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A generic carousel for displaying multiple similar pieces of content along a hor

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).

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/base-carousel
Expand Down Expand Up @@ -345,7 +345,7 @@ Arrow buttons can be customized by passing in your own custom markup. For exampl

## Preact/React Component

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/base-carousel
Expand Down
2 changes: 1 addition & 1 deletion extensions/amp-date-countdown/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ https://github.com/ampproject/amphtml/blob/422d171e87571c4d125a2bf956e78e92444c1

## Preact/React Component

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/date-countdown
Expand Down
2 changes: 1 addition & 1 deletion extensions/amp-date-display/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ https://github.com/ampproject/amphtml/blob/422d171e87571c4d125a2bf956e78e92444c1

## Preact/React Component

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/date-display
Expand Down
4 changes: 2 additions & 2 deletions extensions/amp-embedly-card/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ 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).

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/embedly-card
Expand Down Expand Up @@ -186,7 +186,7 @@ Define a `title` attribute for the component to propagate to the underlying `<if

## Preact/React Component

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/embedly-card
Expand Down
4 changes: 2 additions & 2 deletions extensions/amp-facebook/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Embeds a [Facebook](https://facebook.com) post, a Facebook video, or a comment o

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).

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/facebook
Expand Down Expand Up @@ -449,7 +449,7 @@ Define a `title` attribute for the component to propagate to the underlying `<if

## Preact/React Component

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/facebook
Expand Down
4 changes: 2 additions & 2 deletions extensions/amp-fit-text/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ 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).

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/fit-text
Expand Down Expand Up @@ -148,7 +148,7 @@ Specifies the maximum font size in pixels as an integer that the `bento-fit-text

## Preact/React Component

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/fit-text
Expand Down
4 changes: 2 additions & 2 deletions extensions/amp-iframe/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ 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).

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/iframe
Expand Down Expand Up @@ -140,7 +140,7 @@ You may use the `bento-iframe` element selector to style the component.

## Preact/React Component

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/iframe
Expand Down
4 changes: 2 additions & 2 deletions extensions/amp-inline-gallery/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ 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).

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/inline-gallery
Expand Down Expand Up @@ -155,7 +155,7 @@ You may use the `bento-inline-gallery`, `bento-inline-gallery-pagination`, `bent

## Preact/React Component

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/inline-gallery
Expand Down
4 changes: 2 additions & 2 deletions extensions/amp-instagram/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ 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).

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/instagram
Expand Down Expand Up @@ -127,7 +127,7 @@ You may use the `bento-instagram` element selector to style the component.

## Preact/React Component

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/instagram
Expand Down
4 changes: 2 additions & 2 deletions extensions/amp-jwplayer/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ 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).

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/jwplayer
Expand Down Expand Up @@ -224,7 +224,7 @@ You may use the `bento-jwplayer` element selector to style the accordion freely.

## Preact/React Component

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/jwplayer
Expand Down
6 changes: 3 additions & 3 deletions extensions/amp-lightbox-gallery/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ 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

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/lightbox-gallery
Expand All @@ -19,7 +19,7 @@ import {defineElement as defineBentoLightboxGallery} from '@bentoproject/lightbo
defineBentoLightboxGallery();
```

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

<!--% example %-->

Expand Down Expand Up @@ -163,7 +163,7 @@ Each bento component has a small css library you must include to guarantee prope

The preact/react version of the bentolightboxgallery functions differently than the web component version. The following example will demonstrate the use of `<BentoLightboxGallery>` as a functional component.

### Example: Import Via npm
### Import via npm

```sh
npm install @bentoproject/lightbox-gallery
Expand Down
6 changes: 3 additions & 3 deletions extensions/amp-lightbox/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ 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).

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/lightbox
Expand All @@ -17,7 +17,7 @@ import {defineElement as defineBentoLightbox} from '@bentoproject/lightbox';
defineBentoLightbox();
```

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

<!--% example %-->

Expand Down Expand Up @@ -163,7 +163,7 @@ When the `scrollable` attribute is present, the content of the lightbox can scro

## Preact/React Component

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/lightbox
Expand Down
4 changes: 2 additions & 2 deletions extensions/amp-mathml/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ 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).

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/mathml
Expand Down Expand Up @@ -114,7 +114,7 @@ You may use the `bento-mathml` element selector to style the accordion freely.

## Preact/React Component

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/mathml
Expand Down
4 changes: 2 additions & 2 deletions extensions/amp-selector/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ An input that presents any type of content as list of options. The contents of t

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)

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/selector
Expand Down Expand Up @@ -163,7 +163,7 @@ selector.addEventListener('select', (e) => console.log(e.data.targetOption));

## Preact/React Component

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/selector
Expand Down
4 changes: 2 additions & 2 deletions extensions/amp-sidebar/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ 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).

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/sidebar
Expand Down Expand Up @@ -176,7 +176,7 @@ This attribute is present when the sidebar is open.

## Preact/React Component

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/sidebar
Expand Down
4 changes: 2 additions & 2 deletions extensions/amp-social-share/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ 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).

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/social-share
Expand Down Expand Up @@ -339,7 +339,7 @@ The description of the button for accessibility. A recommended label is "Share o

## Preact/React Component

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/social-share
Expand Down
4 changes: 2 additions & 2 deletions extensions/amp-soundcloud/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ 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).

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/soundcloud
Expand Down Expand Up @@ -148,7 +148,7 @@ The value for this attribute is the ID of a playlist, an integer.</td>

## Preact/React Component

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/soundcloud
Expand Down
4 changes: 2 additions & 2 deletions extensions/amp-stream-gallery/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ It is a specialization of Bento Base Carousel and uses [ResizeObservers](https:/

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).

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/stream-gallery
Expand Down Expand Up @@ -215,7 +215,7 @@ You may use the `bento-stream-gallery` element selector to style the streamGalle

## Preact/React Component

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/stream-gallery
Expand Down
6 changes: 3 additions & 3 deletions extensions/amp-timeago/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ 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).

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/timeago
Expand All @@ -17,7 +17,7 @@ import {defineElement as defineBentoTimeago} from '@bentoproject/timeago';
defineBentoTimeago();
```

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

<!--% example %-->

Expand Down Expand Up @@ -170,7 +170,7 @@ Add the `cutoff` attribute to display the date specified in the `datatime` attri

## Preact/React Component

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/timeago
Expand Down
4 changes: 2 additions & 2 deletions extensions/amp-twitter/1.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ 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).

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/twitter
Expand Down Expand Up @@ -143,7 +143,7 @@ For details on the available options, see Twitter's docs <a href="https://develo

## Preact/React Component

### Example: Import via npm
### Import via npm

```sh
npm install @bentoproject/twitter
Expand Down

0 comments on commit 9dc8f18

Please sign in to comment.