Quick start guide Leave feedback
On this page
This guide shows you how to convert documents to Markdown with GroupDocs.Markdown for Python via .NET. You’ll have working code in under 2 minutes.
flowchart LR
A["Input Document\n(DOCX, PDF, XLSX, EPUB, ...)"]
B["MarkdownConverter"]
C["Markdown Output\n(.md file or string)"]
A --> B --> C
- Install the package from PyPI:
pip install groupdocs-markdown-net
- Import the module:
from groupdocs.markdown import MarkdownConverter
The simplest conversion – one line of code:
from groupdocs.markdown import MarkdownConverter
def convert_word_to_markdown():
"""Convert a Word document to Markdown in one line of code."""
# Step 1: Convert a DOCX file to a Markdown string
markdown = MarkdownConverter.to_markdown("business-plan.docx")
# Step 2: Or save the result directly to a .md file
MarkdownConverter.to_file("business-plan.docx", "convert-word.md")
if __name__ == "__main__":
convert_word_to_markdown()
business-plan.docx is sample file used in this example. Click here to download it.
| HOME BASED | | |
| --- | --- | --- |
| | | |
| PROFESSIONAL SERVICES | | |
| | Business Plan | |
| | TABLE OF CONTENTS TOC \o "1-3" \h \z \u HYPERLINK \l "_Toc9437451" Introduction PAGEREF _Toc9437451 \h 3 HYPERLINK \l "_Toc9437452" 1. Executive Summary PAGEREF _Toc9437452 \h 5 HYPERLINK \l "_Toc9437453" 2. Company Overview PAGEREF _Toc9437453 \h 6 HYPERLINK \l "_Toc9437454" 3. Business Description PAGEREF _Toc9437454 \h 7 HYPERLINK \l "_Toc9437
...
| :
"""Convert a PDF to Markdown with images exported to a folder on disk."""
# Step 1: Configure image export with relative paths
strategy = ExportImagesToFileSystemStrategy("output/images")
strategy.images_relative_path = "images"
# Step 2: Assign the strategy to conversion options
options = ConvertOptions()
options.image_export_strategy = strategy
# Step 3: Convert and save using keyword argument for options
MarkdownConverter.to_file("business-plan.pdf", "output/report.md", convert_options=options)
# Images saved to output/images/
# Markdown references: 
if __name__ == "__main__":
import os
os.makedirs("output/images", exist_ok=True)
convert_pdf_with_images()
business-plan.pdf is sample file used in this example. Click here to download it.
output/images/img-001.jpg (60 KB)
output/images/img-002.png (470 bytes)
output/images/img-003.png (2 KB)
output/images/img-004.jpg (56 KB)
output/images/img-005.png (330 bytes)
output/images/img-006.png (438 bytes)
output/images/img-007.png (438 bytes)
output/images/img-008.png (438 bytes)
output/images/img-009.png (438 bytes)
output/images/img-010.png (438 bytes)
... (35 files total)
output/images/img-001.jpg (60 KB)
output/images/img-002.png (470 bytes)
output/images/img-003.png (2 KB)
output/images/img-004.jpg (56 KB)
output/images/img-005.png (330 bytes)
output/images/img-006.png (438 bytes)
output/images/img-007.png (438 bytes)
output/images/img-008.png (438 bytes)
output/images/img-009.png (438 bytes)
output/images/img-010.png (438 bytes)
[TRUNCATED] (35 files total)
Convert a spreadsheet with column truncation and front matter:
from groupdocs.markdown import MarkdownConverter, ConvertOptions, MarkdownFlavor
def convert_excel_with_options():
"""Convert an Excel spreadsheet with column/row limits, front matter, and GFM flavor."""
# Step 1: Configure spreadsheet-specific conversion options
options = ConvertOptions()
options.max_columns = 8 # limit to first 8 columns
options.max_rows = 50 # limit to first 50 data rows
options.include_front_matter = True # add YAML metadata block
options.flavor = MarkdownFlavor.GIT_HUB # GitHub Flavored Markdown
# Step 2: Open the spreadsheet with a context manager
with MarkdownConverter("cost-analysis.xlsx") as converter:
# Step 3: Inspect document metadata before converting
info = converter.get_document_info()
print(f"Worksheets: {info.page_count}")
# Step 4: Convert using keyword argument for options
result = converter.convert("convert-excel-options.md", convert_options=options)
# Step 5: Check for non-fatal conversion warnings
for w in result.warnings:
print(f"Warning: {w}")
if __name__ == "__main__":
convert_excel_with_options()
cost-analysis.xlsx is sample file used in this example. Click here to download it.
---
title: "Cost Analysis"
author: "GroupDocs"
format: Xlsx
pages: 1
---
## Cost data and chart
...
---
title: "Cost Analysis"
author: "GroupDocs"
format: Xlsx
pages: 1
---
## Cost data and chart
[TRUNCATED]
- Supported document formats – full list of input formats
- Image handling strategies – Base64, file system, skip, custom
- Markdown flavor control – GitHub vs CommonMark
- YAML front matter – for static site generators
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
