将标记转换为重构文本的工具和库(md到rst)
mdToRst的Python项目详细描述
mdtorst
用于将标记转换为重构文本(md到rst)的工具和库。
此工具执行一些基本转换,以尝试生成呈现相同或尽可能接近所提供标记(MD)的重构文本文档(RST)。
这个工具并不完美,可能需要您以某种易于转换的方式写下标记,但它确实节省了大量时间并防止了错误。
为什么?
管理同一文档的两个不同副本是不合理的,而且很容易出错。
我真的很喜欢降价,而且我绝对鄙视重新编排的文本。
不幸的是,github更喜欢降价,而pypi只使用rst,所以我的所有python项目都需要有一个不同的md和rst。
这里的目标是将事情简化到只需编写和维护标记副本(readme.md)的地方,并且在更改之后,您只需通过md to rst运行readme.md即可输出readme.rst。
用法
Usage: mdToRst [filename]
Converts a provided markdown file (.md) to restructed text (.rst)如果“文件名”被提供为“-”,则标记将从stdin中读取。
示例用法:
mdToRst README.md | tee README.rst # Read in README.md, convert to rst,
# and output both to stdout and “README.rst”cat readme.md mdtorst在“readme.md”的内容中插入管道,然后
# output the converted document to stdout
修改
如果您的使用场景中mdtorst生成了不正确或次优的结果,请提交问题详细信息:
- 如何再现问题
- 预期结果是什么
- 为什么这有意义
- 如何在rst中实现等价性
也可以选择提交修补程序。