https://github.com/agility/agilitycms-nuxt-module

Nuxt support for Agility CMS
https://github.com/agility/agilitycms-nuxt-module

agility-cms headless-cms jamstack nuxt

Last synced: about 1 month ago
JSON representation

Nuxt support for Agility CMS

• Host: GitHub
• URL: https://github.com/agility/agilitycms-nuxt-module
• Owner: agility
• License: mit
• Created: 2021-02-26T15:06:56.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-06-17T11:38:58.000Z (over 3 years ago)
• Last Synced: 2024-11-06T03:51:16.562Z (2 months ago)
• Topics: agility-cms, headless-cms, jamstack, nuxt
• Language: JavaScript
• Homepage:
• Size: 18.6 KB
• Stars: 0
• Watchers: 4
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @agility/agilitycms-nuxt-module

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

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

[![License][license-src]][license-href]

> [Agility CMS](https://agilitycms.com/) integration for [NuxtJS](https://nuxtjs.org)

- [📝  Release Notes](https://help.agilitycms.com/hc/en-us/sections/360007518811-Release-Notes)

- [📖  Documentation](https://help.agilitycms.com/hc/en-us/articles/360037500492)

## Features

- Sync Support for Ultra-fast build times

- Full page routing and static rendeer

- Easy async data loading for additional components

## Setup

### 1. Add `@agility/agilitycms-nuxt-module` dependency to your project

```bash

yarn add @agility/agilitycms-nuxt-module

#or

npm install @agility/agilitycms-nuxt-module

```

### 2. Add `@agility/agilitycms-nuxt-module` to the `buildModules` section of `nuxt.config.js`

```js

{

  buildModules: [

    '@agility/agilitycms-nuxt-module',

  ],

  agilitycms: {

    // module options

	channelName: "website",

	languages: ["en-us"],

	includeLanguageCodeInUrl: false,

	pageComponentPath: "src/AgilityPage.vue"

  }

}

```

### 3. Add your Agility CMS instance guid and api keys to `.env`

```

AGILITY_GUID=

AGILITY_API_FETCH_KEY=

AGILITY_API_PREVIEW_KEY=

```

### 4. Use the `$agilitycms` global object to access your Agility CMS Sitemap, Pages and Content.

See the example Agility CMS Nuxt Blog repo for a full example.

https://github.com/agility/agility-nuxt-blog

## License

[MIT License](./LICENSE)

[npm-version-src]: https://img.shields.io/npm/v/@agility/agilitycms-nuxt-module/latest.svg

[npm-version-href]: https://npmjs.com/package/@agility/agilitycms-nuxt-module

[npm-downloads-src]: https://img.shields.io/npm/dm/@agility/agilitycms-nuxt-module.svg

[npm-downloads-href]: https://npmjs.com/package/@agility/agilitycms-nuxt-module

[license-src]: https://img.shields.io/npm/l/@agility/agilitycms-nuxt-module.svg

[license-href]: https://npmjs.com/package/@agility/agilitycms-nuxt-module