- The problem
- The solution
- Quick start (CLI)
- Use it with an AI agent (MCP)
- Install
- Features
- Supported languages
- Built with
- License
- Roadmap
- Contributing
Markdown, rendered beautifully in your terminal — as the mdink CLI, or as an MCP server so AI
agents can render it for you.
🌐 atypical-consulting.github.io/MarkdownInk
Markdown is written to be rendered — but your terminal shows it raw. cat README.md and you get a
wall of #, **, backticks, and | pipe | tables |. Fenced code blocks have no syntax
highlighting. Links are naked URLs. The one place developers live all day is the one place Markdown
looks worst.
It's worse with AI coding agents: when an agent prints Markdown to your terminal, you read the source, not the document.
MarkdownInk parses Markdown with Markdig and paints it with Spectre.Console + TextMateSharp: colored headings, syntax-highlighted code (30+ languages, VS Code's Dark+ theme), bordered tables, task lists, nested block quotes, footnotes, and clickable links.
One rendering engine, two ways to use it:
mdinkCLI — render a file or stdin straight to your terminal.MarkdownInk.Mcpserver — the same engine over MCP, so any AI agent can show Markdown as rich terminal output instead of raw source.
Requires the .NET 10 SDK.
# Build and install the mdink global tool from source
dotnet pack src/MarkdownInk -o nupkg
dotnet tool install -g --add-source nupkg MarkdownInk# Render a file
mdink README.md
# …or pipe from stdin
cat notes.md | mdinkMarkdownInk.Mcp is a stdio Model Context Protocol server. Point
any MCP client at it and the agent gains two read-only tools:
| Tool | What it does |
|---|---|
render_markdown |
Render a Markdown string to terminal-ready output. |
render_markdown_file |
Read a Markdown file from disk and render it. |
Both take ansi (default true — include ANSI color/style codes; false for plain text with the
same layout) and width (default 100 columns). Every call returns a uniform envelope —
{ "ok": true, "data": { "output", "ansi", "width", "lineCount", "path"? } } — or ok: false with
a typed error. Neither tool writes to disk.
Add it to your client config (launched on demand via dnx, the .NET tool runner):
| Method | How |
|---|---|
| mdink CLI | dotnet pack src/MarkdownInk -o nupkg && dotnet tool install -g --add-source nupkg MarkdownInk |
| MCP · dnx | Add the mcpServers config above (needs the .NET 10 SDK). |
| MCP · Docker | docker build -t markdownink-mcp . then docker run -i --rm markdownink-mcp |
| From source | dotnet run --project src/MarkdownInk -- README.md (CLI) · dotnet run --project src/MarkdownInk.Mcp (MCP server) |
- Headings — H1/H2 as full-width rules, H3–H6 as colored text
- Code blocks — syntax highlighting (30+ languages) via TextMateSharp with VS Code's Dark+ theme, in rounded panels with language labels
- Inline formatting — bold, italic, strikethrough, inline code
- Links — clickable hyperlinks (OSC 8) in supported terminals
- Tables — rounded borders and column alignment
- Lists — ordered, unordered, nested, and task lists with checkboxes
- Blockquotes — nested, with colored vertical bars
- Footnotes — numbered references with a dedicated section
- Thematic breaks — clean horizontal rules
Syntax highlighting works for C#, JavaScript, TypeScript, Python, JSON, XML, HTML, CSS, YAML, Bash, SQL, Rust, Go, Java, Ruby, C/C++, PHP, Swift, Kotlin, F#, PowerShell, Markdown, Dockerfile, Makefile, and more.
- Markdig — Markdown parsing
- Spectre.Console — terminal rendering
- TextMateSharp — syntax highlighting
- ModelContextProtocol — the MCP server SDK
MIT — see LICENSE.
MarkdownInk 1.0.0 ships the mdink CLI, the MarkdownInk.Mcp server, Docker/MCPB packaging, and
the marketing site. Beyond that:
- CLI flags for output width and a
--no-color/plain-text mode (today only the MCP tools exposeansi/width; themdinkbinary always renders full-width ANSI) - A selectable syntax theme beyond TextMateSharp's bundled VS Code Dark+ (light-terminal users currently get one look)
- Package the
mdinkCLI for Homebrew/Scoop/WinGet sodotnet tool installisn't the only install path - Broader Markdown coverage — e.g. Mermaid/diagram fences and image previews in supported terminals
- A pager/scroll mode for documents taller than the terminal, instead of a single full render
See the open issues for what's next.
Part of a suite of Model Context Protocol servers by Atypical Consulting:
- RoselineMCP — Roslyn code intelligence for AI agents
- ASTral — structured code retrieval (tree-sitter)
- AdrMcp — Architecture Decision Records over MCP
- MarkdownInk — Markdown rendering for the terminal
Contributions are welcome. Open an issue first to discuss any significant change.
- Fork the repository and create your branch (
git checkout -b feat/my-feature) - Commit your changes (
git commit -m 'feat: ...') - Push the branch and open a Pull Request
Built by Atypical Consulting. We also make NuGetKeep, a self-hosted NuGet server with supply-chain quarantine.


{ "mcpServers": { "markdownink": { "command": "dnx", "args": ["MarkdownInk.Mcp", "--yes"] } } }