md_generator.archive API Reference¶
Summary¶
| Item | Value |
|---|---|
| Purpose | Convert ZIP archives to Directory-oriented Markdown bundle |
| CLI | md-zip |
| Extra | archive plus nested format extras |
| Tier | medium |
Quick CLI reference¶
| Argument | Type | Required | Default | Choices | Help |
|---|---|---|---|---|---|
input |
Path | required | — | — | Input archive path |
output |
Path | required | — | — | Output directory (writes document.md and assets/) |
-v |
flag | optional | false | — | — |
--no-office |
flag | optional | false | — | Skip PDF/DOCX/PPTX/XLSX conversion |
--image-ocr |
flag | optional | false | — | Run tesseract on extracted images |
--no-image-ocr |
str | optional | — | — | — |
--use-image-to-md |
flag | optional | false | — | Enable post-pass image-to-md OCR (default: on); see --image-to-md-engines |
--no-use-image-to-md |
str | optional | — | — | Disable post-pass image-to-md over assets/files and assets/images |
--image-to-md-engines |
str | optional | DEFAULT_IMAGE_TO_MD_ENGINES | — | — |
--image-to-md-strategy |
str | optional | 'best' | ('best', 'compare') | image-to-md --strategy (default: best) |
--image-to-md-title |
str | optional | '' | — | Top-level title passed to image-to-md (default: derived from filename) |
--pdf-ocr |
flag | optional | false | — | Pass --ocr to pdf-to-md for nested PDFs |
--max-bytes |
int | optional | 512000 | — | Max UTF-8 bytes for inlined text bodies (default: 512000) |
--repo-root |
Path | optional | None | — | Deprecated: ignored (install extras, e.g. mdengine[pdf,word], for embedded office files) |
--no-expand-nested-zips |
flag | optional | false | — | Do not recursively extract nested archives under assets/files/ |
Primary symbols¶
| Symbol | Kind | Notes |
|---|---|---|
| convert_archive | callable | — |
| convert_zip | callable | — |
| extract_archive | callable | — |
Python API (mkdocstrings)¶
archive ¶
zip-to-md: ZIP archive to Markdown + assets.