nuxt-feed-yandex-market/README.md

A Nuxt.js module that generates an YML file. Example for Yandex.Market

# A Nuxt.js module that generates an XML file for Yandex.Market (YML)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

A wrapper over [Yandex Market Language(YML)](https://github.com/LotusTM/yandex-market-language) that generates a JSON object into the xml file, heavily inspired by [nuxt-community/feed-module](https://github.com/nuxt-community/feed-module). The module supports Nuxt 2.x. There is `yarn run generate` support.

## Simple usage

- Install `yarn add nuxt-feed-yandex-market`
- Add `nuxt-feed-yandex-market` to `modules` section of `nuxt.config.js`

```js
export default {
  modules: [
    'nuxt-feed-yandex-market'
  ],
  // @deprecated use feedYml
  yandexMarket: {},
  feedYml: {
    data: {}, // JSON with data or a function that returns the JSON 
    path: '/yandex-market.xml', // The route to your xml file
    validate: true,
    cacheTime: 1000 * 3600 * 24 
  }
}
```

or

```js
export default {
  modules: [
    'nuxt-feed-yandex-market'
  ],
  feedYml: [
    {
      async data () {
        // await axios
        return {
          name: 'SuperShop',
          company: 'Tne Best inc.',
          url: 'https://yesworld.github.io/portfolio/',
          ...
        }
      },
      path: '/yandex-market.xml',
      validate: true,
      cacheTime: 1000 * 3600 * 24
    },
    {
      data: {},
      path: '/aliexpress.xml'
    }
  ]
}
```

## License

[MIT License](./LICENSE)

Copyright (c) :suspect: @yesworld