用于记录YAML文件的简单工具
项目描述
- 版权:
- 2015-2019 by Hartmut Goebel
- 许可:
GNU通用公共许可证v3或更高版本(GPLv3+)
此工具允许您将文档直接写入YAML文件作为注释。然后,这些注释将被转换为文本,YAML代码将进入文本块。
这类似于一种文献编程,除了您不是在文本中写入代码,而是在代码中写入文本。这种差异允许直接处理YAML文件,而无需任何预处理。
用法
yaml2rst [-h] [--strip-regex regex] infile outfile positional arguments: infile YAML-file to read (`-` for stdin) outfile rst-file to write (`-` for stdout) optional arguments: -h, --help show this help message and exit --strip-regex regex Regex which will remove everything it matches. Can be used to remove fold markers from headings for example. Example to strip out [[[,]]] fold markers: '\s*(:?\[{3}|\]{3})\d?$'. Check the README for more details.
它是如何工作的
本脚本将所有以 # 开头(以及只包含 # 的行)的行作为文本行处理。其余所有内容将被视为“代码”。文本行将移除 #,而“代码”将添加前导空格。
此外,根据 reStructuredText 的要求,在“代码”块的开始和结束处,将添加所需的行。如果在“代码”块的开始处需要,还将添加 ::。
--strip-regex 可用于在需要时从文本行中删除匹配的字符。有关 折叠标记支持 的详细信息,请参阅文档。
示例
您可以在示例目录中找到示例 yaml 输入、rst 输出和生成的 html。您还可以在网上查看生成的 html,网址为 https://rawgit.com/debops/yaml2rst/develop/examples/main.html。
维护者
yaml2rst 最初于 2015 年开发,由 Hartmut Goebel 维护。2019 年,该项目迁移到了 debops 项目,为该项目开发了 yaml2rst。
项目详情
下载文件
下载适用于您的平台的文件。如果您不确定选择哪个,请了解更多关于 安装软件包 的信息。
源分布
yaml2rst-0.3.tar.gz (26.4 kB 查看哈希)
构建分布
yaml2rst-0.3-py2.py3-none-any.whl (8.4 kB 查看哈希)
关闭
yaml2rst-0.3.tar.gz 的哈希
算法 | 哈希摘要 | |
---|---|---|
SHA256 | b517836b5d84d76b5b479ea8ba59bddef3f7bbe3bbb8ba770334b2dd2856b28b |
|
MD5 | ccbefec2037523764216b706f7379c19 |
|
BLAKE2b-256 | de881685f29d0627ec24bb0ccf790a4f1d0d276a4949db4288835163bd9b8c66 |
关闭
yaml2rst-0.3-py2.py3-none-any.whl 的哈希
算法 | 哈希摘要 | |
---|---|---|
SHA256 | e563869fb1797ab3c560bca2d916b50b5df49003a22e2f77b5ec2b1c37430d54 |
|
MD5 | 3049d5ff40f229563bd59c97ba223f14 |
|
BLAKE2b-256 | 93af1720183746de57e8a9dba661e65afc8afe0fc490fc7a8cd044f7cd3cf3c4 |