Why Markr

The built-in Markdown preview is useful, but it is intentionally minimal. Markr is built for people who spend real time in Markdown: documentation, specs, README files, notes, AI instructions, changelogs, and long-form project files.

Open any .md file and run Markr: Open Markr Preview or press:

Highlights

Workspace Navigation

Markr includes a file panel for Markdown-heavy projects. It indexes workspace .md files, groups them by folder, lets folders collapse, highlights AI configuration files, and lets you switch between files without leaving the preview.

The file list loads asynchronously so the preview can appear quickly even in projects with many Markdown files. You can control the list size with markr.maxWorkspaceFiles.

AI Markdown Files

Modern development projects often contain Markdown files that define agent behavior, coding rules, prompts, skills, memory, and context. Markr detects and highlights common AI docs, including:

• AGENTS.md
• SKILL.md and skills.md
• CLAUDE.md, codex.md, gemini.md, and Copilot instruction files
• Cursor, Windsurf, Aider, prompt, rule, memory, and context Markdown files

AI docs open directly into split edit mode, show a clear type badge, and stay grouped at the top of the file panel. The split can be resized, and switching to preview is remembered for that file during the session. Use the Source toolbar action to jump from Markr into the normal VS Code Markdown editor whenever you want the full editor experience.

Markdown Rendering

Markr supports the Markdown features expected in modern documentation:

• Headings, lists, tables, blockquotes, links, images, and inline code
• Fenced code blocks with syntax highlighting
• GitHub-style task lists
• GitHub alerts: NOTE, TIP, IMPORTANT, WARNING, and CAUTION
• Mermaid diagrams through fenced mermaid blocks
• Frontmatter display for Markdown files that use metadata

Editing Tools

Use split edit mode when you want to make quick changes without leaving the preview. The formatting toolbar supports common Markdown actions such as bold, italic, headings, links, images, lists, code, quotes, and horizontal rules.

Changes are saved back to the active Markdown file.

Export Tools

Markr includes practical export actions directly in the toolbar:

Settings

Requirements

• VS Code 1.80.0 or newer
• Internet access for Mermaid rendering from jsDelivr
• Chrome, Edge, or Chromium for direct PDF export

All non-Mermaid preview features work offline.

Feedback

Report issues or request features on GitHub:

https://github.com/Apptware-Product-Labs/markr/issues

Built by Apptware Product Lab. Licensed under MIT.