Skip to content

Commit

Permalink
Update addon docs
Browse files Browse the repository at this point in the history
  • Loading branch information
prototypa committed Jun 20, 2022
1 parent d8df626 commit 236292d
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 39 deletions.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at prototypearea.com@gmail.com. All
reported by contacting the project team at hello@onwidget.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Expand Down
91 changes: 54 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,29 @@
# Storybook AMP · [![npm package](https://img.shields.io/npm/v/storybook-amp?color=green&label=npm&style=flat-square)](https://www.npmjs.com/package/storybook-amp)
# Storybook AMP Html · [![npm package](https://img.shields.io/npm/v/storybook-amp?color=green&label=npm&style=flat-square)](https://www.npmjs.com/package/storybook-amp)

Storybook addon for [AMP (Accelerated Mobile Pages)](https://amp.dev/). Allows to display in your stories *AMP Html* components generated with React.

![Screenshot](screenshot.png)

<details open="open">
<summary>Table of Contents</summary>

- [Features](#features)
- [Demo](#demo)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Examples](#examples)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Acknowledgements](#acknowledgements)
- [Links](#links)

</details>

<br />

## Features

- Deliver in each story the output code (AMP ready) resulting from the SSR.
Expand All @@ -14,19 +34,20 @@ Storybook addon for [AMP (Accelerated Mobile Pages)](https://amp.dev/). Allows t

## Demo

<a href="https://demo.onwidget.com/storybook-amp/" target="_blank">demo.onwidget.com/storybook-amp/</a>
- [Storybook AMP Html Demo](https://demo.onwidget.com/storybook-amp/)

<br />

## Installation
## Getting Started

### Installation

```sh
npm install -D storybook-amp
```

<br />

## Configuration
### Configuration

Next, update `.storybook/main.js` to the following:

Expand All @@ -45,9 +66,8 @@ module.exports = {
};
```

<br />

## Usage
### Usage

To set custom settings, use the `amp` parameter.

Expand Down Expand Up @@ -93,42 +113,39 @@ export const Story = (args) => (
)
```

For more examples and configurations go to the [Demo](#demo)
### Examples

- [React](https://github.com/onwidget/storybook-amp/tree/main/example)

<br />

### Tested Addons Compatibility

<ul>
<li>
Addon Viewport
</li>
<li>
Addon Controls
</li>
<li>
Addon Backgrounds
</li>
<li>
Addon Storysource
</li>
<li>
Addon Docs (Coming soon)
</li>
<li>
Addon Toolbars (Coming soon)
</li>
<li>
Addon Accessibility (Coming soon)
</li>
<li>
Addon Chromatic (Coming soon)
</li>
</ul>
## Roadmap

- Make it compatible with the *Chromatic addon*
- Make it compatible with the *Accessibility addon*
- Adjust UI details when used with *Docs addon*
- More tools for *AMP Ads* and *AMP Email*
- Add more example tests
- Add tests
- Make CI integration possible

<br />

## AMP Documentation
## Contributing

Storybook AMP Html addon is an open-source project. We are committed to a fully transparent development process and appreciate highly any contributions. Whether you are helping us fix bugs, proposing new features, improving our documentation or spreading the word - we would love to have you as part of the community.

Please refer to our [Contribution Guidelines](https://github.com/onwidget/storybook-amp/blob/main/CONTRIBUTING.md) and [Code of Conduct](https://github.com/onwidget/storybook-amp/blob/main/CODE_OF_CONDUCT.md).

## License

The Storybook AMP Html addon is licensed under the MIT license — see the [LICENSE](https://github.com/onwidget/storybook-amp/blob/main/LICENSE) file for details.

## Acknowledgements

Initially created by [onWidget](https://onwidget.com) and maintained by a community of [contributors](https://github.com/onwidget/storybook-amp/graphs/contributors).

## Links

- [AMP Project](https://amp.dev/)
- [Awesome Amp](https://github.com/onwidget/awesome-amp)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
"node": ">=14"
},
"storybook": {
"displayName": "Storybook AMP",
"displayName": "Storybook AMP Html",
"unsupportedFrameworks": [],
"supportedFrameworks": [
"react"
Expand Down

0 comments on commit 236292d

Please sign in to comment.