将标记转换为重构文本的工具和库(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中实现等价性

也可以选择提交修补程序。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java是否在servlet中检索上一页路径?   Java抱怨在开关的默认情况下未初始化最终字段   Java泛型:为什么编译器不能判断这个类<t>对象与这个类的类型参数的对象的类具有相同的类型?   Java:继承方法中使用的私有变量   HibernateJava。ClassCastException:java。lang.Integer不能强制转换为abc。def。我的项目。奥姆。EmployeeTopMetaData   http java发布和下载文件   java改进条件检查   java如何将2d数组的条目作为键放在地图中   java如何获取传递给运行时的值。getRuntime。JUnit测试用例中的exit(value)   java注释来创建所有可能的构造函数   自动建议列表:java。lang.IllegalArgumentException:在XPath表达式为null时找不到元素   为什么MapAPI在Java中不提供流功能?   gradle不导入本地java库   尽管我使用的是SessionCreationPolicy,java Spring安全性似乎仍在使用会话。无国籍   使用java查找MongoDB中数组元素的平均值