groupdocs-markdown-net 26.3.0

Product Page | Docs | API Reference | Examples | Blog | Free Support | Temporary License

GroupDocs.Markdown for Python via .NET is a Markdown processing and conversion API. Convert documents to Markdown and Markdown back to other formats with full control over formatting, flavors, and rendering.

Get Started

pip install groupdocs-markdown-net

from groupdocs.markdown import MarkdownConverter

md = MarkdownConverter.to_markdown("document.docx")
print(md)

How It Works

The package is a self-contained Python wheel that includes everything needed to process documents. No external software installation is required - just pip install and start converting. The wheel works across Python 3.5 - 3.14 on Windows, Linux, and macOS (Intel + Apple Silicon).

Features

• Document to Markdown: Convert DOCX, PDF, XLSX, PPTX, HTML, EPUB and 20+ formats to Markdown.
• Markdown to Document: Convert Markdown back to PDF, DOCX, and other formats.
• Markdown Flavors: CommonMark and GitHub Flavored Markdown (GFM).
• Spreadsheet Control: Max rows, columns, sheet separator, hidden sheets.
• Heading & Metadata: Heading level offset, YAML front matter.
• Cross-Platform: Windows x64/x86, Linux x64, macOS x64/ARM64.

Supported Conversions

Examples

Convert to Markdown String

from groupdocs.markdown import MarkdownConverter

md = MarkdownConverter.to_markdown("./report.docx")
print(md)

Save Markdown to File

from groupdocs.markdown import MarkdownConverter

MarkdownConverter.to_file("./report.pdf", "./report.md")

Convert with Options

from groupdocs.markdown import MarkdownConverter, ConvertOptions, MarkdownFlavor, SkipImagesStrategy

with MarkdownConverter("./document.docx") as converter:
    options = ConvertOptions()
    options.flavor = MarkdownFlavor.GIT_HUB
    options.heading_level_offset = 1
    options.include_front_matter = True
    options.image_export_strategy = SkipImagesStrategy()

    result = converter.convert(options)
    print(result.content)

Convert with Load Options

from groupdocs.markdown import MarkdownConverter, LoadOptions

load_opts = LoadOptions()
load_opts.password = "secret"

md = MarkdownConverter.to_markdown("./protected.docx", load_options=load_opts)
print(md)

Get Document Info

from groupdocs.markdown import MarkdownConverter

info = MarkdownConverter.get_info("./document.docx")
print(f"Format: {info.file_format}")
print(f"Pages: {info.page_count}")

Convert from Stream / BytesIO

import io
from groupdocs.markdown import MarkdownConverter, ConvertOptions, SkipImagesStrategy

with open("document.docx", "rb") as stream:
    with MarkdownConverter(stream) as converter:
        result = converter.convert(ConvertOptions())
        print(result.content)

buf = io.BytesIO(downloaded_bytes)
with MarkdownConverter(buf) as converter:
    options = ConvertOptions()
    options.image_export_strategy = SkipImagesStrategy()
    result = converter.convert(options)
    print(result.content)

Spreadsheet Options

from groupdocs.markdown import MarkdownConverter, ConvertOptions, SkipImagesStrategy

with MarkdownConverter("./data.xlsx") as converter:
    options = ConvertOptions()
    options.max_columns = 10
    options.max_rows = 50
    options.include_hidden_sheets = False
    options.image_export_strategy = SkipImagesStrategy()

    result = converter.convert(options)
    print(result.content)

AI Agent & LLM Friendly

This package is designed for seamless integration with AI agents, LLMs, and automated code generation tools.

• AGENTS.md in the package — AI coding assistants (Claude Code, Cursor, GitHub Copilot) auto-discover the API surface, usage patterns, and troubleshooting tips from the installed package
• MCP server — connect your AI tool to GroupDocs documentation for on-demand API lookups:

  { "mcpServers": { "groupdocs-docs": { "url": "https://docs.groupdocs.com/mcp" } } }
  

• Machine-readable docs — full documentation available as plain text for RAG and LLM context:
  • Single file: https://docs.groupdocs.com/markdown/python-net/llms-full.txt
  • Per page: append .md to any docs URL
• Markdown output for RAG — clean, structured Markdown is the preferred input for LLMs and embedding pipelines

Evaluation Mode

The API works without a license in evaluation mode with the following limitations:

• Only the first 3 pages of a document are processed.
• An evaluation watermark is added to the output.

To remove these limitations, apply a license or request a temporary license:

from groupdocs.markdown import License
License().set_license("path/to/license.lic")

Or set the environment variable (auto-applied at import):

export GROUPDOCS_LIC_PATH="path/to/license.lic"

Troubleshooting

System Requirements

• Python: 3.5 - 3.14
• Platforms: Windows x64/x86, Linux x64, macOS x64/ARM64
• No external dependencies on Windows. Linux/macOS may need ICU (see Troubleshooting).