|
| 1 | +# MarkdownPointer |
| 2 | + |
| 3 | +**Vibe writing for Markdown.** Point at anything, tell AI to fix it. |
| 4 | + |
| 5 | +MarkdownPointer renders your Markdown and lets you click any element — headings, code blocks, table cells, Mermaid diagram nodes, KaTeX math — to copy a `filepath:line` reference. Paste it into your AI prompt, and the AI knows exactly where to look. This npm package bundles the MCP server and the viewer app — no separate installation needed. |
| 6 | + |
| 7 | +<div align="center"> |
| 8 | + <img width="640" alt="social-image" src="https://github.com/user-attachments/assets/cdae3548-1e23-4639-9b38-3e03c5c2a337" /> |
| 9 | +</div> |
| 10 | + |
| 11 | +## Install |
| 12 | + |
| 13 | +### Claude Code |
| 14 | + |
| 15 | +```bash |
| 16 | +claude mcp add mdp -- npx -y markdown-pointer |
| 17 | +``` |
| 18 | + |
| 19 | +### Claude Desktop |
| 20 | + |
| 21 | +Add to your Claude Desktop config (`%APPDATA%\Claude\claude_desktop_config.json`): |
| 22 | + |
| 23 | +```json |
| 24 | +{ |
| 25 | + "mcpServers": { |
| 26 | + "mdp": { |
| 27 | + "command": "npx", |
| 28 | + "args": ["-y", "markdown-pointer"] |
| 29 | + } |
| 30 | + } |
| 31 | +} |
| 32 | +``` |
| 33 | + |
| 34 | +### Other MCP Clients |
| 35 | + |
| 36 | +Use `npx -y markdown-pointer` as the command in your MCP client's configuration. |
| 37 | + |
| 38 | +## Usage |
| 39 | + |
| 40 | +Ask Claude: |
| 41 | + |
| 42 | +- "open README.md in mdp" |
| 43 | +- "show the report in mdp and scroll to line 50" |
| 44 | +- "export report.md to docx" |
| 45 | +- "export slides.md to pptx" |
| 46 | +- "import presentation.pptx to markdown" |
| 47 | +- "show me slide 3 of slides.md" |
| 48 | + |
| 49 | +## MCP Tools |
| 50 | + |
| 51 | +| Tool | Description | |
| 52 | +|------|-------------| |
| 53 | +| `show_markdown` | Open files and scroll to a line | |
| 54 | +| `get_status` | Get current window/tab state | |
| 55 | +| `slide_control` | Navigate reveal.js slides | |
| 56 | +| `get_slide_info` | Get slide shapes and content as text | |
| 57 | +| `get_slide_image` | Get a slide as PNG image (requires PowerPoint) | |
| 58 | +| `export_document` | Export to .pptx (built-in) or .docx (Pandoc) | |
| 59 | +| `import_document` | Import .docx/.pptx to Markdown + extract images | |
| 60 | +| `tag_asset` | Tag imported files and images in index.json | |
| 61 | + |
| 62 | +## Features |
| 63 | + |
| 64 | +| Feature | Description | |
| 65 | +|---------|-------------| |
| 66 | +| Point & Prompt | Click any rendered element to copy `filepath:line` to clipboard | |
| 67 | +| Mermaid Diagrams | Flowchart, Sequence, Class, State, ER, Gantt, Pie, Git graph, Mindmap | |
| 68 | +| KaTeX Math | Inline `$...$` and block `$$...$$` | |
| 69 | +| SVG | Embedded font support | |
| 70 | +| Live Reload | Auto-refresh on file changes | |
| 71 | +| Export | `.pptx` (built-in Open XML), `.docx` (via Pandoc). Mermaid/SVG rendered as images | |
| 72 | + |
| 73 | +## Requirements |
| 74 | + |
| 75 | +- Windows 10/11 |
| 76 | +- [.NET 10 Desktop Runtime](https://dotnet.microsoft.com/download/dotnet/10.0) |
| 77 | + |
| 78 | +## Also Available |
| 79 | + |
| 80 | +Install via [PowerShell Gallery](https://www.powershellgallery.com/packages/MarkdownPointer) for PowerShell integration: |
| 81 | + |
| 82 | +```powershell |
| 83 | +Install-Module MarkdownPointer |
| 84 | +``` |
| 85 | + |
| 86 | +## License |
| 87 | + |
| 88 | +MIT |
0 commit comments