https://github.com/nuxt-community/amp-module

AMP Module for Nuxt 2
https://github.com/nuxt-community/amp-module

amp nuxt-module

Last synced: about 2 months ago
JSON representation

AMP Module for Nuxt 2

• Host: GitHub
• URL: https://github.com/nuxt-community/amp-module
• Owner: nuxt-community
• License: mit
• Created: 2019-04-18T12:25:12.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-12-19T17:03:02.000Z (9 months ago)
• Last Synced: 2023-12-20T11:54:42.780Z (9 months ago)
• Topics: amp, nuxt-module
• Language: Vue
• Homepage: https://codesandbox.io/s/github/nuxt-community/amp-module/
• Size: 3.1 MB
• Stars: 206
• Watchers: 8
• Forks: 36
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ⚡ @nuxtjs/amp

[![npm version][npm-version-src]][npm-version-href]

[![npm downloads][npm-downloads-src]][npm-downloads-href]

[![Circle CI][circle-ci-src]][circle-ci-href]

[![Codecov][codecov-src]][codecov-href]

[![Dependencies][david-dm-src]][david-dm-href]

[![Standard JS][standard-js-src]][standard-js-href]

> AMP (Accelerated Mobile Pages) Module for Nuxt 2

Looking for a Nuxt 3 alternative? Try out:

- [@vite-pwa/nuxt](https://vite-pwa-org.netlify.app/frameworks/nuxt.html)

**DEMO**: https://codesandbox.io/s/github/nuxt-community/amp-module/

[📖 **Release Notes**](./CHANGELOG.md)

## Docs

* Getting Started

  * [Introduction](docs/README.md)

  * [Setup](docs/guide/setup.md)

  * [Usage](docs/guide/usage.md)

  * [Styling](docs/guide/styling.md)

* Reference

  * [API](docs/api/readme.md)

    * [Options](docs/api/options.md)

    * [AMP elements](docs/api/amp-elements.md)

    * [Components](docs/api/components.md)

## Setup

1. Add the `@nuxtjs/amp` dependency with `yarn` or `npm` to your project

2. Add `@nuxtjs/amp` to the `modules` section of `nuxt.config.js`

3. Configure it:

```js

{

  modules: [

    // Simple usage

    '@nuxtjs/amp',

    // With options

    ['@nuxtjs/amp', { /* module options */ }]

  ]

}

```

## Development

1. Clone this repository

2. Install dependencies using `yarn install` or `npm install`

3. Start development server using `npm run dev`

## License

[MIT License](./LICENSE)

Copyright (c) Ahad Birang 

[npm-version-src]: https://img.shields.io/npm/dt/@nuxtjs/amp.svg?style=flat-square

[npm-version-href]: https://npmjs.com/package/@nuxtjs/amp

[npm-downloads-src]: https://img.shields.io/npm/v/@nuxtjs/amp/latest.svg?style=flat-square

[npm-downloads-href]: https://npmjs.com/package/@nuxtjs/amp

[circle-ci-src]: https://img.shields.io/circleci/project/github/nuxt-community/amp-module.svg?style=flat-square

[circle-ci-href]: https://circleci.com/gh/nuxt-community/amp-module

[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-community/amp-module.svg?style=flat-square

[codecov-href]: https://codecov.io/gh/nuxt-community/amp-module

[david-dm-src]: https://david-dm.org/nuxt-community/amp-module/status.svg?style=flat-square

[david-dm-href]: https://david-dm.org/nuxt-community/amp-module

[standard-js-src]: https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square

[standard-js-href]: https://standardjs.com