如何用Python在Confluence新建页面并嵌入Markdown from URL宏？

一、用Python通过Confluence API创建页面并嵌入宏 #

Confluence页面内容采用XHTML存储格式，嵌入宏需构造对应的宏标签结构，具体步骤如下：

1. 安装依赖库

pip install confluence-python-api

2. 编写Python代码

from atlassian import Confluence

# 初始化Confluence客户端
confluence = Confluence(
    url='https://你的Confluence域名.atlassian.net',
    username='你的邮箱@example.com',
    password='你的API Token'
)

# 构造Markdown from URL宏的XHTML内容
macro_html = """
<ac:structured-macro ac:name="markdown-from-url">
    <ac:parameter ac:name="url">https://example.com/你的Markdown文件.md</ac:parameter>
    <!-- 可选参数：render-mode 设为view仅渲染，edit允许编辑 -->
    <ac:parameter ac:name="render-mode">view</ac:parameter>
</ac:structured-macro>
"""

# 创建新页面
confluence.create_page(
    space="你的空间KEY",  # 示例："PROJECT"
    title="带Markdown宏的测试页面",
    body=macro_html,
    representation='storage'  # 必须指定为storage格式
)

关键说明 #

• url参数：填写可被Confluence访问的Markdown文件地址（公网或内部网络地址均可）
• API Token：需在Atlassian账号的「Security」设置中生成，用于替代密码验证
• 确保账号拥有目标空间的页面创建权限，以及使用markdown-from-url宏的权限

二、用HTML代码添加该宏组件 #

若通过HTML构造Confluence页面内容，或在Confluence的HTML宏中嵌入该组件，直接插入宏的XHTML结构即可：

示例HTML代码 #

<div class="confluence-content">
    <ac:structured-macro ac:name="markdown-from-url">
        <ac:parameter ac:name="url">https://example.com/你的Markdown文件.md</ac:parameter>
        <ac:parameter ac:name="render-mode">view</ac:parameter>
    </ac:structured-macro>
</div>

注意事项 #

• 若在Confluence页面的HTML宏中使用，需管理员提前开启HTML宏功能（Confluence默认禁用）
• 宏标签需符合Confluence的XHTML规范，否则无法被正确解析渲染

内容的提问来源于stack exchange，提问作者mat656