README

Markdown

Orchestra MCP Markdown plugin — universal markdown parser with theme-aware code blocks, syntax highlighting, interactive tables with sorting/search/export, and Blade component integration.

Features

Theme-Aware Rendering — Code blocks and tables inherit colors from the active Orchestra theme via CSS custom properties
8 Built-in Code Themes — GitHub Dark/Light, Monokai, Dracula, One Dark, Nord, Solarized Dark/Light
Syntax Highlighting — Regex-based highlighter for PHP, JavaScript, TypeScript, Python, Go, Rust, SQL, CSS, HTML, Bash, JSON
Interactive Tables — Sortable columns, live search, CSV export, image export, raw copy
Code Block Controls — Copy, file export, image export with gradient backgrounds
Blade Components — <x-markdown>, <x-markdown-code>, <x-markdown-table>
Themes Integration — Reads active Orchestra theme CSS variables (--mt-*) as fallbacks
2 MCP Tools — Render markdown and list available themes
1 Artisan Command — List available markdown themes

Requirements

PHP 8.2+
Laravel 12.x
orchestra-mcp/plugins package
orchestra-mcp/themes package
league/commonmark ^2.6

Installation

composer require orchestra-mcp/markdown

The service provider is auto-discovered.

Quick Start

Render Markdown

use OrchestraMcp\Markdown\Facades\Markdown;

$html = Markdown::render('# Hello World');

Standalone Code Block

$html = Markdown::renderCodeBlock('$x = 1;', 'php', 'dracula');

Blade Components

{{-- Full markdown rendering --}}
<x-markdown content="# Hello **World**" />

{{-- Inline slot --}}
<x-markdown>
## Features
- Item one
- Item two
</x-markdown>

{{-- Standalone code block --}}
<x-markdown-code code="echo 'hi';" language="php" theme="monokai" />

{{-- Interactive table --}}
<x-markdown-table
    :headers="['Name', 'Age']"
    :rows="[['Alice', '30'], ['Bob', '25']]"
    :sortable="true"
    :searchable="true"
/>

List Themes

php artisan markdown:themes
php artisan markdown:themes --type=dark

Code Block Features

Feature	Config Key	Default
Copy button	`code_blocks.copy_button`	`true`
File export	`code_blocks.export_button`	`true`
Image export	`code_blocks.image_export`	`true`
Syntax highlighting	`code_blocks.syntax_highlighting`	`true`
Max height	`code_blocks.max_height`	`500px`

Table Features

Feature	Config Key	Default
Sortable columns	`tables.sortable`	`true`
Live search	`tables.searchable`	`true`
CSV export	`tables.export.csv`	`true`
Image export	`tables.export.image`	`true`
Copy raw	`tables.export.copy_raw`	`true`
Striped rows	`tables.striped`	`true`

Image Export

Code blocks and tables can be exported as PNG images with gradient backgrounds.

Code Export	Table Export

MCP Tools

Tool	Annotation	Description
`markdown-render`	`#[IsReadOnly]`	Render markdown to HTML with themed code blocks and tables
`markdown-theme-list`	`#[IsReadOnly]`	List available syntax highlighting themes

Theme Integration

Markdown styles use CSS custom properties with cascading fallbacks:

--md-bg  →  --mt-bg-alt  →  #0d1117 (hardcoded default)
--md-fg  →  --mt-fg      →  #e6edf3

When the Orchestra themes plugin sets --mt-* variables, markdown components automatically inherit them. Code blocks use --md-* variables that can be overridden per-block via data-md-theme attributes.

Configuration

Publish the config:

php artisan vendor:publish --tag=orchestra-markdown-config

Key	Default	Env Variable	Description
`enabled`	`true`	`ORCHESTRA_MARKDOWN_ENABLED`	Enable/disable markdown plugin
`theme`	`'github-dark'`	`ORCHESTRA_MARKDOWN_THEME`	Default code block theme
`marketplace`	`true`	—	Marketplace visibility

Documentation

Full documentation is available in the docs/ directory:

Getting Started — Installation, configuration, quick start
Architecture — Parser, highlighter, theme system
Tools — MCP tool reference
Commands — Artisan command reference
Configuration — Full config key reference
API Reference — Facades, services, components

Development

# Install dependencies
composer install

# Run tests
composer test

# Format code
composer format

# Static analysis
composer check

# Lint
composer lint

License

MIT

orchestra-mcp / markdown

Maintainers

Details