利用Python实现Markdown文档格式转换详解

git clone git@github.com:microsoft/markitdown.git
cd markitdown
pip install -e packages/markitdown[all]

import pandas as pd
import numpy as np

# 生成一些示例数据
np.random.seed(0)
data = {
    'name': ['alice', 'bob', 'charlie', 'david', 'eve', 'frank'],
    'age': [25, 30, 35, 40, 45, 50],
    'gender': ['female', 'male', 'male', 'male', 'female', 'male'],
    'score1': np.random.randint(0, 100, 6),
    'score2': np.random.randint(0, 100, 6)
}

# 创建一个基本的dataframe
df = pd.dataframe(data)

# 添加多级索引
index = pd.multiindex.from_product([['group a', 'group b'], 
                                    ['subgroup 1', 'subgroup 2', 'subgroup 3']], 
                                   names=['group', 'subgroup'])
df.index = index

# 计算每行的总分和平均分
df['total score'] = df[['score1', 'score2']].sum(axis=1)
df['average score'] = df[['score1', 'score2']].mean(axis=1)

# 显示表格
# print(df)

# 保存表格为xlsx文件
df.to_excel('test.xlsx')

# 将excel转换为markdown文件
from markitdown import markitdown

# 通过传递enable_plugins=fals参数，表明在进行转换时不启用插件功能
md = markitdown(enable_plugins=false) 

# 调用md对象的convert方法，将test.xlsx文件进行转换
result = md.convert("test.xlsx")
# text_content为一个字符串
print(result.text_content)
# 返回结果为字典
print(result.__dict__)

# 将结果保存为markdown文件
# 定义要保存的markdown文件的文件名
output_file = "output.md"

# 以写入模式打开文件，如果文件不存在则创建
with open(output_file, 'w', encoding='utf-8') as file:
    # 将转换后的文本内容写入文件
    file.write(result.text_content)

import random
import string
# pip install fpdf
from fpdf import fpdf
from pil import image, imagedraw, imagefont

# 生成随机文字
def generate_random_text(length):
    letters = string.ascii_letters + string.digits + string.punctuation
    return ''.join(random.choice(letters) for i in range(length))

# 生成随机图片
def generate_random_image(width, height):
    # 创建一个随机颜色的图片
    image = image.new('rgb', (width, height), color=(
        random.randint(0, 255),
        random.randint(0, 255),
        random.randint(0, 255)
    ))
    draw = imagedraw.draw(image)
    font = imagefont.load_default()
    # 在图片上添加随机文字
    text = generate_random_text(20)
    draw.text((10, 10), text, fill=(255, 255, 255), font=font)
    image_path = 'random_image.png'
    image.save(image_path)
    return image_path

# 创建pdf并添加随机图片和文字
def create_pdf():
    pdf = fpdf()
    pdf.add_page()

    # 添加随机文字到pdf顶部
    top_text = generate_random_text(100)
    pdf.set_font("arial", size=12)
    pdf.multi_cell(0, 10, txt=top_text)
    # 生成随机图片
    image_path = generate_random_image(300, 200)
    # 添加图片到pdf
    pdf.image(image_path, x=10, y=pdf.get_y(), w=100)
    # 移动到图片下方
    pdf.ln(210)
    # 添加随机文字到pdf底部
    bottom_text = generate_random_text(100)
    pdf.multi_cell(0, 10, txt=bottom_text)

    # 保存pdf
    pdf.output("test.pdf")

# 创建pdf
create_pdf()
from markitdown import markitdown
# 将文档转换为markdown
# azure文档智能：可以使用microsoft文档智能进行转换
md = markitdown(docintel_endpoint="<document_intelligence_endpoint>")
# 不会转换pdf中的图片
result = md.convert("test.pdf")
print(result.text_content)

from markitdown import markitdown
from openai import openai

client = openai()
md = markitdown(llm_client=client, llm_model="gpt-4o")
result = md.convert("example.jpg")
print(result.text_content)

import markdown
print(f'markdown version: {markdown.__version__}')

# 定义markdown文本
markdown_text = """
# 这是一个markdown标题
这是一段普通文字，后续为列表项需要换行或者4个空格。

- 列表项 1
- 列表项 2

[markdown超链接](https://www.example.com)
"""

# 将markdown文本转换为 html
html_text = markdown.markdown(markdown_text)

# 打印转换后的html文本
print(html_text)

import markdown

def create_example_markdown(file_path):
    example_content = """
# markdown示例标题

这是一个示例的markdown文件内容。

## 子标题

下面是一个无序列表：

- 列表项 1
- 列表项 2

这里还有一个有序列表：

1. 有序项 1
2. 有序项 2
"""

    try:
        with open(file_path, 'w', encoding='utf-8') as file:
            file.write(example_content)
        print("示例 markdown 文件已创建。")
    except exception as e:
        print(f"错误: 创建文件时发生未知错误: {e}")

def read_markdown_file(file_path):
    try:
        with open(file_path, 'r', encoding='utf-8') as file:
            return file.read()
    except filenotfounderror:
        print(f"错误: 文件 {file_path} 未找到。")
        return none
    except exception as e:
        print(f"错误: 读取文件时发生未知错误: {e}")
        return none

# 创建本地示例markdown文件
file_path = 'example.md'
create_example_markdown(file_path)

markdown_text = read_markdown_file(file_path)
if markdown_text is not none:
    html_text = markdown.markdown(markdown_text)
    print(html_text)

from markdown.treeprocessors import treeprocessor
from markdown.extensions import extension

class markdownstyleprocessor(treeprocessor):
    # 遍历html节点设置不同参数
    def run(self, tree_root):
        for element in tree_root.iter():
            if element.tag == "h1":
                element.set("class", "custom-h1")
                element.set("style", "color: #007bff; font-size: 2.5em; margin-bottom: 0.5em;")
            elif element.tag == "h2":
                element.set("class", "custom-h2")
                element.set("style", "color: #00ff00; font-size: 1.1em; margin-bottom: 0.3em;")

class markdownstyleextension(extension):
    # 该方法用于扩展markdown对象
    def extendmarkdown(self, markdown_obj):
        # markdown_style定义处理的名字。10表示表示处理器的优先级，值越大越往后处理
        markdown_obj.treeprocessors.register(markdownstyleprocessor(markdown_obj), "markdown_style", 10)

import markdown

try:
    with open("example.md", "r", encoding="utf-8") as file:
        markdown_content = file.read()

    # 将markdown内容转换为html，同时使用自定义的扩展
    html_result = markdown.markdown(
        markdown_content,
        extensions=[markdownstyleextension()]
    )
    print(html_result)
except exception as e:
    print(f"发生错误: {e}")

# 示例

示例代码如下[^1]：

print("hello world!")

示例表格如下[^2]：

|姓名|年龄|
|:-|-:|
|张三|16|
|李四|23|

[^1]: 示例代码
[^2]: 示例表格

import markdown

with open("example.md", "r", encoding="utf-8") as fd:
    markdown_text = fd.read()

# 通过extensions参数设置转换格式
html_output = markdown.markdown(
    markdown_text,
    extensions=["tables", "footnotes", "fenced_code"]
)

print(html_output)