Skip to main content

Domain Frontmatter Config

Overview​

Domains are just markdown files, with this comes the use of Content, MDX components and also front-matter.

Here is an example of the domain frontmatter you will find in your domain folders/files.

---
name: Orders
summary: |
  Domain that contains everything about orders
owners:
    - dboyne
    - mSmith
---

Required fields​

name​

  • Type: string

Name of the domain (needs to match the domain folder name)

Example
---
  name: Orders
---

Optional fields​

summary​

Short summary of your domain, shown on domain summary pages.

Example
---
  summary: |
    Domain that contains everything about orders
---

owners​

An array of user ids that own the domain.

Example
---
  owners:
    - dboyne
    - mSmith
---

List of URLs that can be used when people want to reference to external documentation.

  • Type: Tag
    • label: value that gets rendered on the UI
    • href: URL for link
Example
---
  externalLinks: 
    - label: AsyncAPI Specification
      url: https://studio.asyncapi.com/#schema-lightMeasuredPayload
---