# indexdoc-converter
**Repository Path**: indexdoc/indexdoc-converter
## Basic Information
- **Project Name**: indexdoc-converter
- **Description**: indexdoc-converter 是一款基于 Python 开发的文档转换工具库，核心功能为将主流办公文档、网页文件高效转换为 Markdown 格式。各类型文件支持格式如下： Word 文档支持 .docx ； Excel 类表格文档支持 .xlsx、.xls、.ods、.csv、.tsv ； 网页文件支持 .html、.mhtml、.htm 及网页url PPT 演示文档支持 .ppx
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://www.indexdoc.com/
- **GVP Project**: No
## Statistics
- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-02-13
- **Last Updated**: 2026-02-24
## Categories & Tags
**Categories**: Uncategorized
**Tags**: Markdown转换
## README
---
# indexdoc-converter Document Conversion Library
**indexdoc-converter** is a Python-based document conversion toolkit, designed to efficiently convert mainstream office documents and web files into Markdown format. Supported file types are as follows:
- Word documents: **.docx**
- Excel & spreadsheet files: **.xlsx, .xls, .ods, .csv, .tsv**
- Web files: **.html, .mhtml, .htm** and web URLs
- PowerPoint presentations: **.pptx**
This library has been published to PyPI (Python Package Index) and can be quickly installed and used via the `pip` package manager.
[](https://www.python.org/) [](https://github.com/indexdoc/indexdoc-converter.git) [](https://opensource.org/licenses/MIT)
## Library Usage
```bash
# Install the library
pip install -U indexdoc-converter # Install the latest version
```
- Minimum Python version required: **Python 3.10**
### Package Directory Structure
```bash
indexdoc-converter/ # Project root directory
├── indexdoc_converter/ # Core package directory
│ ├── __init__.py # Core code entry
│ ├── docx_to_md.py # Word to Markdown converter class
│ ├── excel_to_md.py # Excel to Markdown converter class
│ ├── html_to_md.py # HTML to Markdown converter class
│ ├── pptx_to_md.py # PPT to Markdown converter class
│ └── utils/
│ ├── __init__.py
│ ├── FileUtil.py
│ ├── IDUtil.py
│ └── img_to_base64.py
```
### Usage Examples
```bash
# Import note: use indexdoc_converter (underscore), NOT indexdoc-converter (hyphen)
from indexdoc_converter.docx_to_md import convert_docx_to_md
from indexdoc_converter.excel_to_md import TableToMarkdown
from indexdoc_converter.html_to_md import convert_to_md
from indexdoc_converter.pptx_to_md import pptx_to_md
# -------------------------------------------Word to Markdown---------------------------------------------------
md_text = convert_docx_to_md(r"C:\Users\xxx\test_document.docx", False)
with open('./test.md', 'w', encoding='utf-8') as f:
f.write(md_text)
# -------------------------------------------Excel to Markdown-------------------------------------------------
# Custom parameters example
converter = TableToMarkdown(
file_title_level=2, # Markdown heading level for file title, default 1 (#), set to 2 (##) here
single_row_value_as_title=True, # Treat a single row of unique values as header, default True
max_rows=8000, # Max rows to process, default 6000 (actual: max_rows + 1)
max_cols=200 # Max columns to process, default 128 (actual: max_cols + 1)
)
# Convert single file
file_path = r"C:\Users\xxx\test_file.xlsx"
result = converter.convert(file_path)
# blank mode: preserve merged cell original style (content only in top-left cell, others empty)
with open("../tmp/test_blank.md", "w", encoding="utf-8") as f:
f.write(result['blank'])
# fill mode: fill merged cell content into all merged cells;
# automatically detects header rows, splits multiple table blocks, handles blank rows/columns,
# and supports parsing merged cells in diverse table layouts
with open("../tmp/test_fill.md", "w", encoding="utf-8") as f:
f.write(result['fill'])
# -------------------------------------------PPT to Markdown---------------------------------------------------
ppt_file = r"C:\Users\xxx\test_file.pptx"
md_path = pptx_to_md(ppt_file)
print(f"Single file conversion completed, MD file path: {md_path}")
# -------------------------------------------Web File to Markdown-----------------------------------------------
# html = "https://news.qq.com/rain/a/20260114A01NI000"
html = "https://www.aituple.com"
# html = "https://www.indexdoc.com"
# html = r"C:\Users\xxx\test_file.html"
# html = "https://www.indexdoc.com/contact.html"
md = convert_to_md(html, '../tmp/test_html.md')
# md = mhtml_to_markdown(mhtml)
```
## Conversion Previews
### Word Document
#### Original Document
#### Converted Document
### Excel Document
#### Original Document
#### Converted Document
### PPT Document
#### Original Document
#### Converted Document
### Web File
#### Original Document
#### Converted Document
## Secondary Development
- Python 3.10 or higher
```bash
# Source code repository
https://gitee.com/indexdoc/indexdoc-converter.git
```
```bash
# Quick installation of dependencies
pip install -r requirements.txt
# Using Alibaba Cloud PyPI mirror
pip install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/
```
## Contact
- Author: Hangzhou Zhiyu Data Information Technology Co., Ltd.
- Email: indexdoc@qq.com