将降价文档转换为合流
md2cf的Python项目详细描述
中密度纤维板
将用降价方式写入的文档转换为合流存储的库 格式化，并可选地将它们上载到合流服务器实例。
功能
- 转换标记文档。库实现 Mistune输出 合流存储格式。
- basic confluence api支持。嵌入式微实现 那张Confluence Server REST API 具有创建和更新页面的基本支持。
- upload automation。包含一个小脚本，可以自动执行 为您上传过程。
安装
pip install md2cf
基本用法
渲染器
使用ConfluenceRenderer类生成合流存储格式
标记文档的输出。
import mistune from md2cf.confluence_renderer import ConfluenceRenderer renderer = ConfluenceRenderer(use_xhtml=True) confluence_mistune = mistune.Markdown(renderer=renderer) confluence_body = confluence_mistune(markdown_data)
api
md2cf嵌入了汇流服务器rest的微小实现 允许您创建、读取和更新页面的API。
from md2cf.api import MinimalConfluence confluence = MinimalConfluence(host='http://example.com/rest/api', username='foo', password='bar') confluence.create_page(space='TEST', title='Test page', body='<p>Nothing</p>', message='Created page') page = confluence.get_page(title='Test page', space_key='TEST') confluence.update_page(page=page, body='New content', message='Changed page contents')
上传脚本
要上载文档，您至少需要提供 以下五个参数：
- 汇流实例的hostname，包括
rest api（例如
http://confluence.example.com/rest/api） - 用于登录实例的username
- 相应的密码
- 上载页面的空间
- 要上载的文件或标准输入（如果列表是 缺少
基本示例 用法：
md2cf --host 'https://confluence.example.com/rest/api' --username foo --password bar --space TEST document.md
请注意，在命令行上输入密码作为参数是
一般来说是个坏主意。如果以交互方式运行脚本，则
可以省略--password参数，脚本将提示输入该参数。
另外，对于那些有安全意识的人
使用这个作为管道的一部分，还可以提供主机名，
用户名和密码为环境变量：CONFLUENCE_HOST，
CONFLUENCE_USERNAME，和CONFLUENCE_PASSWORD。
页面的title将是在
文档（即第一个#头）或文件名（如果有）
没有顶层标题。
如果要在a特定父级下上载页，请提供
父页ID作为--parent参数。
您还可以选择指定update消息来描述
使用--message参数更改您刚才所做的更改。
欢迎加入QQ群-->： 979659372
