Skip to main content

What is MDX?

EventCatalog uses MDX file format for documentation.

Markdown is what powers EventCatalog, we encourage and follow a docs-as-code approach. This lets you write documentation in your favorite IDE and version control system, review changes, merge and deploy them.

Using MDX gives you powerful features like:

How to refer to frontmatter in your documentation​

You can refer to your frontmatter in your documentation using the frontmatter variable.

events/MyEvent/index.mdx
---
id: MyEvent
name: My Event
version: 1.0.0
summary: My Event Summary
---

<!-- This will render My Event -->
# {frontmatter.name}

<!-- This will render My Event Summary -->
{frontmatter.summary}

How to use variables in your documentation​

MDX supports using the export statements to add variables to your documentation.

For example you can export a title field from an MDX page or component and use it as a heading.

events/MyEvent/index.mdx
---
id: MyEvent
name: My Event
version: 1.0.0
summary: My Event Summary
---

<!-- This will export the variable title -->
export const title = "My Event"

<!-- This will render the title -->
# {title}