Skip to main content
View as Markdown

The design document

A design document is what a design is made of: its blocks, settings and content, as JSON. You get it from getDesign(), from every export (design), and from designs.get (doc).

What you may rely on​

  • Store it as it is, and hand it back: to lettrove.render({ doc }), or to open it again.
  • It always opens. A design saved by any 1.x editor opens and renders in every later 1.x editor, unchanged. A design with blocks from a newer editor opens in an older one with those blocks kept exactly as they are.
  • It is JSON, safe to put in any JSON column or document store.

What you may not​

  • Its shape is Lettrove', not a public format. Fields are added between releases, and what each means is not documented. Do not read values out of it or change it by hand: a design changed by hand may be refused (design_invalid).
  • For the information you would want from it — its name, subject, preheader, mode, the merge tags in it, its HTML or text — use an export, whose fields are documented and stable.