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.

Sign up for GitHub

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

Jump to bottom

fixed some heading errors #27464

Merged
merged 2 commits into from Mar 31, 2020
Merged

fixed some heading errors #27464

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2cc375
fixed some heading errors
CrystalOnScript Mar 27, 2020
d4008be
moved version notes and added to template
CrystalOnScript Mar 31, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions build-system/tasks/extension-generator/extension-doc.template.md
View file
Open in desktop
Expand Up @@ -156,6 +156,10 @@ Explain analytics.

Accessibility information related to `${name}`.

## Version notes (optional)

Information on version differences and migration notes.

## Validation

See [\${name} rules](https://github.com/ampproject/amphtml/blob/master/extensions/${name}/validator-${name}.protoascii) in the AMP validator specification.
2 changes: 1 addition & 1 deletion extensions/amp-accordion/amp-accordion.md
View file
Open in desktop
Expand Up @@ -28,7 +28,7 @@ limitations under the License.

Provides a way for viewers to glance at the content outline and jump to any section. This is helpful for mobile devices where even a couple of sentences into a section requires scrolling.

## Behavior
## Usage

The `amp-accordion` component allows you to display collapsible and expandable content sections. This component provides a way for viewers to glance at the content outline and jump to any section. Effective use reduces scrolling needs on mobile devices.

Expand Down
22 changes: 7 additions & 15 deletions extensions/amp-next-page/amp-next-page.md
View file
Open in desktop
Expand Up @@ -24,21 +24,6 @@ limitations under the License.

# amp-next-page

## Behavior

Given a list of pages, `amp-next-page` tries to load them after the current
document, providing an infinite-scroll type experience.

Pages should be specified in a JSON config loaded from a remote URL listed in
the element `src`, or inlined as a `script` element child.

## Version notes

| Version | Description |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1.0 | Support for an infinite number of page recommendations, reduced bundle size, improved API, support for amp-analytics, templated separators and recommendation box, better handling of fixed elements.<br><br>API changes are breaking, please take a look at the [migration section](https://amp.dev/documentation/components/amp-next-page/#migrating-from-0.1) for details. |
| 0.1 | Initial experimental implementation. Limited to three recommended documents |

## Usage

The `<amp-next-page>` component loads content pages one after another creating an infinite scroll experience.
Expand Down Expand Up @@ -396,6 +381,13 @@ The default recommendation box and default separator both have a generic, non-lo

Both the default recommendation box and default separator are keyboard-focusable. When a custom separator is provided, its `tabindex` is preserved if present, otherwise a `tabindex` of `0` will be added to the given element.

## Version notes

| Version | Description |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1.0 | Support for an infinite number of page recommendations, reduced bundle size, improved API, support for amp-analytics, templated separators and recommendation box, better handling of fixed elements.<br><br>API changes are breaking, please take a look at the [migration section](https://amp.dev/documentation/components/amp-next-page/#migrating-from-0.1) for details. |
| 0.1 | Initial experimental implementation. Limited to three recommended documents |

## Validation

See [amp-next-page rules](https://github.com/ampproject/amphtml/blob/master/extensions/amp-next-page/validator-amp-next-page.protoascii)
Expand Down