vuepress-plugin-data v2.0.0

vuepress-plugin-data

Inject external data into a VuePress site.

Install

npm install -D vuepress-plugin-data

# or

yarn add -D vuepress-plugin-data

Usage

1. Add plugin to your VuePress config

There are multiple ways to do this. Here is one way:

// .vuepress/config.js
module.exports = {
  plugins: [
    ['vuepress-plugin-data', {
      // plugin options go here, see next step
    }]
  ]
}

2. Specify the data

Specify the data in the plugin options as an array of key/value pairs.

// .vuepress/config.js
module.exports = {
  plugins: [
    ['vuepress-plugin-data', {
      data: [
        {
          key: 'count',
          // can be static value
          value: 5
        },
        {
          key: 'rando',
          // can be function
          value() {
            return Math.random();
          }
        },
        {
          key: 'speakers',
          // can be function that returns Promise
          value() {
            return axios.get('https://example.org/api/speakers')
              .then(response => response.data);
          }
        },
        {
          key: 'cities',
          // can be async function
          async value() {
            return await axios.get('https://example.org/api/cities')
              .then(response => response.data);
          }
        }
      ]
    }]
  ]
}

3. Access the data

Your data is accessible in the vppData object.

Data is injected using a global mixin:

Vue.mixin({
  data() {
    return {
      vppData: {
        // Your data will be in here by the keys you specified
      }
    };
  }
});

This means all pages and components can access the data directly.

3a. Access data in a page

---
title: My Site
---

- {{vppData.count}}
- {{vppData.rando}}

<ul>
  <li v-for="city in vppData.cities" :key="city.id">
    {{city.name}}
  </li>
</ul>

3b. Access data in a Vue component

export default {
  computed: {
    speakerCount() {
      return this.vppData.speakers.length;
    }
  }
};

API

PluginOptions

interface PluginOptions {
  /**
   * Array of data specs.
   *
   * Each data spec is one piece of data to inject.
   */
  data: Array<DataSpec>;
}

DataSpec

interface DataSpec {
  /**
   * The property name for this injected data.
   *
   * Must be unique across all other data specs.
   */
  key: string;
  /**
   * The value for this injected data.
   *
   * Any of
   *   - json serializable value
   *   - function that returns a json serializable value
   *   - function that returns a Promise that resolves to a json serializable value
   *   - async function that returns a json serializable value
   *   - Promise that resolves to a json serializable value
   */
  value: any;
}

Caveats

• Because the data is in the initial js bundle, all data is eagerly loaded by your site.

License

MIT