markitdown
/markitdown
Convert PDF, Office, HTML, image, audio and other files, URLs, or stdin streams to Markdown with the dsh-markitdown plugin (Microsoft MarkItDown). Use when the user asks to extract text or tables from a document, convert a file or YouTube link to Markdown, or make an attachment readable.
- Author
- AlbertZJ ↗
- Repository
- dsh-markitdown ↗
- Licence
- MIT
- Last repository change
- 26.10.2026
Assessment and security
- Files in this package
- 1
- Scripts
- 0
- HTML comments
- 0
- URLs in SKILL.md
- 0
No signals detected. Repository changed on 26.10.2026, without references to retired models or APIs.
MIT, open: use and modify while retaining author attribution.
What it does and when to use it
Convert PDF, Office, HTML, image, audio and other files, URLs, or stdin streams to Markdown with the dsh-markitdown plugin (Microsoft MarkItDown). Use when the user asks to extract text or tables from a document, convert a file or YouTube link to Markdown, or make an attachment readable.
Original author description
Convert PDF, Office, HTML, image, audio and other files, URLs, or stdin streams to Markdown with the dsh-markitdown plugin (Microsoft MarkItDown). Use when the user asks to extract text or tables from a document, convert a file or YouTube link to Markdown, or make an attachment readable.
How it works
- Workflow
- Hints and flags
- URL sources and egress
- DOCX images: export by default, descriptions optional
- Supported local inputs
- Rules
- Known limitations (set expectations)
SKILL.md preview
---
name: markitdown
description: Convert PDF, Office, HTML, image, audio and other files, URLs, or stdin streams to Markdown with the dsh-markitdown plugin (Microsoft MarkItDown). Use when the user asks to extract text or tables from a document, convert a file or YouTube link to Markdown, or make an attachment readable.
---
# MarkItDown document conversion
Convert sources to Markdown through the plugin's `markitdown_check` and
`markitdown_convert` tools. MarkItDown runs as a Python package
(`python -m markitdown`) in the plugin's configured interpreter; the tools
own the process, timeout and error handling.
## Workflow
1. **Verify the environment once per session** with `markitdown_check`.
- `ready: true` → continue.
- `ready: false` → the detail field contains the exact setup command
(`<command> -m pip install 'markitdown[all]'`). Show it to the user and
stop; do not retry conversions until they confirm setup.
2. **Convert** with `markitdown_convert`. Pick the mode:
- `path`: one absolute local file path or an http(s) URL (e.g. a YouTube
link, when the `[all]` extra is installed).
- `paths`: a batch (up to 16) of paths/URLs; per-source failures are
captured in `results` and do not abort the batch.
- `stdinBase64`: canonical base64 bytes; requires `extensionHint` or
`mimeHint` so MarkItDown can pick a converter.
3. **Where the Markdown goes**:
- Omit `output`/`outputDir` to get Markdown inline — right for summaries
and sources under ~100 KiB.
- `output` (single source) or `outputDir` (writes `<name>.md` per source)
— right for large documents, batch jobs and when the user asks for
converted files on disk. DOCX conversions also write a sibling
`<name>.media/` directory with the embedded images.
4. **Report** what was converted, where the Markdown went, and any caveats
below that apply to the source format.
## Hints and flags
`extensionHint` / `mimeHint` / `charsetHint` map to the MarkItDown CLI's
`-x` / `-m` / `-c` flags. `extensionHint` also admits local files whose
extension is not in the built-in supported list, and is required for stdin;
hinted extensions are validated against the supported list plus a small set
of plain-text formats (txt, log, yaml, yml, toml, ini, cfg, conf, rss, atom,
py, js, ts, css, sh). `keepDataUris` keeps base64 image payloads (by default
they are truncated). Third-party MarkItDown converter plugins (`-p`) run
only when the plugin admin enables `allowPlugins` in the plugin config.
## URL sources and egress
`path`/`paths` accept http(s) URLs (e.g. YouTube links). Every URL is
downloaded with connection-pinned egress validation before conversion: the
plugin resolves the host itself, connects only to a globally routable
address (the checked address is the connected address, so DNS rebinding
cannot swap targets mid-handshake), follows redirects manually with the
same check per hop, and hands the downloaded bytes to MarkItDown via a
temporary file — MarkItDown never re-resolves the host. Internal addresses
(loopback, private, link-local) are refused unless the admin sets
`allowPrivateUrls`. YouTube transcript URLs are the documented exception:
the URL itself is passed to MarkItDown (its converter requires it), still
after the same pinned connection check.
## DOCX images: export by default, descriptions optional
Markitdown 0.1.x never routes Word images through its LLM client, so a DOCX
would otherwise carry `` blobs. The bundled
helper instead exports every `word/media` image in document order next to the
Markdown (`<name>.media/`) and replaces each placeholder with a file link —
no model, no API key. Inline conversions use a temp directory (absolute
links); pass `output`/`outputDir` when the images should persist.
When the user wants the text inside the screenshots without opening each
image, the model can describe them: enable **Describe images with the active
model** on Settings → MarkItDown (`describeImages`; off by default). Each link
then carries a `> **图 N**(word/media/...)` description block. This costs one
model call per distinct image and needs:
- the `openai` package in the same Python environment
(`<command> -m pip install openai`),
- an active provider with its API key stored in the dsh credential store —
Settings → MarkItDown (endpoint, model, key) — or exported in the
`llmApiKeyEnv` environment variable as a fallback.
Descriptions run at temperature 0 and must transcribe text verbatim, mark
unreadable text and undeterminable senders instead of guessing, and name the
source part so the original can be inspected. Large images (> 8 MiB) are not
exported or described (reported inline), and a failed description is reported
inline instead of aborting the document. Descriptions are still one-shot:
when exact wording matters, open the exported image (the session's own image
reading) instead of trusting the text.
`markitdown_check` reports whether descriptions are on and whether the helper
can reach a key. Without them, conversion stays fully offline and images are
only exported.
## Supported local inputs
PDF, DOCX/DOC, PPTX/PPT, XLSX/XLS/CSV (tables become Markdown tables),
JSON/XML, HTML/HTM, EPUB, MD, Outlook MSG, ZIP (each contained file
converted in place), JPG/JPEG/PNG/GIF/TIFF/BMP (EXIF metadata, OCR text
when available), WAV/MP3 (speech transcription, needs the `[all]` extra).
Anything else: refuse conversion and say the format is not supported,
unless the user provides an `extensionHint` that MarkItDown understands.
## Rules
- Always run `markitdown_check` before the first conversion in a session;
a green check earlier in the conversation counts.
- Local paths must be absolute and the file must exist; URLs must start
with http(s)://. Errors say which check failed.
- Files above the configured size limit are rejected — suggest splitting
or shrinking the file.
- Batch jobs run sequentially inside the tool; never fire several
`markitdown_convert` calls in parallel for the same batch.
- Do not install Python packages yourself unless the user explicitly asks;
surface the setup command from `markitdown_check` and let them decide.
## Known limitations (set expectations)
- Scanned PDFs without a text layer convert to little or no text; say so
instead of presenting an empty result as success.
- Complex layouts (multi-column, heavy styling) flatten into linear Markdown.
- YouTube transcription depends on the `[all]` extra and current page
structure; failures surface the MarkItDown error — report it, do not retry
in a loop.
- DOCX embedded images are exported as files beside the Markdown. Inline
conversions use a temp directory that may be cleaned up; prefer
`output`/`outputDir` when the images matter. With descriptions enabled,
expect one model call per distinct image and scale `timeoutMs` for
image-heavy documents.
Versions
| Repository | Score | Licence |
|---|---|---|
| This page · AlbertZJ/dsh-markitdown | 90 | MIT |
| TerminalSkills/skills | 100 | Apache-2.0 |
| pleaseai/claude-code-plugins | 100 | MIT |
| matematicsolutions/awesome-matematic-skills-pl | 100 | MIT |
| rashadansari/myagents | 100 | MIT |
| julianobarbosa/claude-code-skills | 100 | MIT |
| jacardl/viceroy-skills | 98 | MIT |
| 0xDarkMatter/claude-mods | 95 | MIT |
| jackspace/ClaudeSkillz | 95 | MIT |
Database snapshot: 13.11.2026 · package version d59bc9707046 (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 100markitdown-skill
Convert documents to Markdown using Microsoft's MarkItDown CLI (`markitdown`). Supports PDF, Word, PowerPoint, Excel, images (OCR), audio (transcription), HTML, YouTube, and URLs. Use when a user wants to convert a file or URL to Markdown, extract text from PDFs/images,… - 100convert-to-markdown
Use when the user references a local PDF, Office document, spreadsheet, presentation, HTML file, CSV/data file, or ovd-workflow knowledge-vault document and the agent should convert it to clean Markdown before reading to reduce tokens and preserve structure. Uses Microsoft's… - 100alterlab-markitdown
Converts files and Office documents to clean, LLM-friendly Markdown with Microsoft MarkItDown (markitdown CLI, Python API, and markitdown-mcp server), supporting PDF, DOCX, PPTX, XLSX/XLS, images (EXIF metadata, LLM descriptions), audio (transcription), HTML, CSV, JSON, XML, ZIP… - 100markitdown-convert
Convert any file to Markdown using Microsoft MarkItDown. Use this skill whenever the user needs to extract text from PDFs, Word documents, Excel spreadsheets, PowerPoints, EPUBs, images, audio, HTML pages, CSV, JSON, XML, ZIP archives, Jupyter notebooks, Outlook .msg files, or… - 100markdown-converter
Convert documents and files to Markdown using markitdown. Use when converting PDF, Word (.docx), PowerPoint (.pptx), Excel (.xlsx, .xls), HTML, CSV, JSON, XML, images (with EXIF/OCR), audio (with transcription), ZIP archives, YouTube URLs, or EPubs to Markdown format for LLM… - 100to-markdown
Convert any file or URL to clean Markdown: PDF, DOCX, XLSX, PPTX, HTML, images (OCR), audio, CSV, YouTube. Optimised for LLM pipelines. Triggers on: "convert to markdown", "extract text from PDF", "parse this document", "ingest for RAG".