跳转到主要内容

将markdown转换为restructed text(md到rst)的工具和库

项目描述

mdToRst

将markdown转换为restructed text(md到rst)的工具和库。

此工具执行一些基本转换,以尝试生成一个restructed text文档(RST),该文档显示与提供的markdown(md)相同或尽可能接近。

此工具并不完美,可能需要您按照有利于转换的方式编写markdown,但它确实节省了大量时间并防止了错误。

为什么?

管理同一份文档的两个不同副本既没有意义,又非常容易出错。

我真的很喜欢markdown,但我绝对讨厌restructed text。

很遗憾,GitHub偏好使用Markdown,而pypi只会使用RST,所以我的所有Python项目都需要分别有独立的MD和RST文件。

这里的目标是将事情简化到只需编写和维护一个Markdown副本(README.md),然后在更改后,只需运行README.md通过mdToRst即可输出README.rst。

使用方法

使用方法:mdToRst [文件名]

将提供的Markdown文件(.md)转换为结构化文本(.rst)

如果“文件名”提供为“--”,则Markdown将从stdin读取。

示例用法

mdToRst README.md | tee README.rst # 读取README.md,转换为rst,

# 并将两者输出到stdout和“README.rst”

cat README.md | mdToRst # 将“README.md”的内容管道输入,

# 并将转换后的文档输出到stdout

修改

如果您有mdToRst生成不正确或次优结果的使用场景,请提交一个问题,详细说明

  • 如何重现问题

  • 预期的结果是什么

  • 为什么这样做是有意义的

  • 如何在RST中实现等效的

并且可以提交补丁。

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定要选择哪个,请了解更多关于安装包的信息。

源分布

mdToRst-1.1.0.tar.gz (24.5 kB 查看哈希值)

上传时间

支持者

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面