Project Config

The project config defines the project specific config, contentTypes and designs. To build a custom design the designSettings and components can be modified.

Example:

module.exports = {
  v: 2,
  $baseRevision: 5,

  settings: require('./settings'),
  contentTypes: [
    require('./content-types/regular')
  ],
  designSettings: require('./design-settings'),
  components: [
    require('./components/title'),
    require('./components/p'),
    require('./components/image')
  ]
}

v

This is the version of the config schema. This value is fixed.

$baseRevision

This is an internal property used for version management.

settings

settings.js can be used to configure a channel (project).

References

contentTypes

A project can have multiple contentTypes. An example for a contentTypes is a “Regular article” or a “Gallery article”. Every contentType can have different components and metadata.

References

designSettings

In designSettings you can build component groups, add external assets, define default components and a lot more.

References

components

Components are the heart of a Livingdocs design. You can design your own components like a paragraph-, an image- or a bullet-list-component.

❗ Restrictions

At the moment following changes on the design are not supported.

  • rename a directive in a component
  • rename a component
  • add a new directive to a component
  • remove a component (please remove it only from the content-type)

References