Overview

Documentation often lives outside your Mendix project — in Confluence, SharePoint, or scattered Word documents. This leads to outdated docs, constant context switching, and no version control over your project documentation. The Mendix Markdown Editor solves this by bringing Markdown directly into Studio Pro.

This extension adds a new Markdown document type to your App Explorer. Right-click any folder or module, select Add other → Markdown, and start writing. Your documents are stored inside your project and version controlled alongside your models.

The editor is powered by Monaco, the same engine behind VS Code. You get syntax highlighting, word wrap, header folding, and a familiar editing experience without leaving Studio Pro. Switch to Preview mode to see your rendered output instantly.

Full GitHub Flavored Markdown (GFM) is supported, including tables, task lists, footnotes, strikethrough, autolinks, and code blocks with syntax highlighting for all major languages.

Need diagrams? Mermaid is built in with support for 18+ diagram types: flowcharts, sequence diagrams, class diagrams, ER diagrams, state diagrams, Gantt charts, pie charts, mindmaps, timelines, architecture diagrams, Kanban boards, and more. All rendered inline in your preview — no external tools needed.

Monaco is bundled locally, so the extension works fully offline without any CDN dependency.

Documentation

Typical usage scenario

Keep your project documentation where it belongs, inside your Mendix project. Instead of maintaining separate docs in Confluence, SharePoint, or Word files, create Markdown documents directly in Studio Pro. Use it for module READMEs, architecture documentation with Mermaid diagrams, API docs, changelogs, technical specs, or meeting notes. Everything is stored in your project and version controlled alongside your models.

Features

• Native Markdown document type in App Explorer with custom icons
• Monaco editor (VS Code's engine) with syntax highlighting, word wrap, and header folding
• Live preview with full GitHub Flavored Markdown support (tables, task lists, footnotes, strikethrough, autolinks, code blocks)
• Mermaid diagram rendering with 18+ diagram types (flowcharts, sequence, class, ER, Gantt, pie, mindmap, architecture, Kanban, and more)
• Auto-save and undo/redo via Studio Pro's native system
• Fully offline — Monaco is bundled locally, no CDN required

Known bugs

No known bugs at this time. If you encounter any issues, please reach out.