Sharing data between plugins

What's the datastore

Limedocs expose a unique (single instance) datastore shared between all virtual viles. The datastore is a simple read-write key-value object.

Reading from the datastore

Each virtual file object exposes a .datastore object property that you can read.

Populating the datastore

Populating the datastore is usually done by Transformation plugins. The following plugins support populating datastore from data found in files, automatically:

  • transformer-json populates the datastore from JSON keys storeId and store.
  • transformer-yaml populates from YAML properties storeId and store.
  • transformer-markdown populates from front-matter keys storeId and store.

Edit this page / submit change