markdown文件转RST文件

markdown 文件转RST文件时遇到的一些问题

最近需要把一些markdown文件转成RST文件，第一次接触RST文件，使用中会有一些语法问题需要注意。在这里做个记录。

转化工具

我们可以先采用工具对整体做个初步的转换。因为转换工具不能做到完美转换，在初步转换完成后再根据实际的显示情况进行下一步的调整。这里推荐一个网站：MD在线转换成RST 如果不注册的话，每天最多可以转化10个文件。

后续调整

转换后的大体格式是正确的，包括不同级别的标题，一些加粗斜体显示等，但是很多细节还是要自己调整的。

1.网页链接
RST中的网页链接写法是 ` XXX（链接描述） <网页> ` _

2.插入图片
RST中插入图片的语法为
… figure:: 图片地址
:aligh: center(如果要居中的话)

3.跳转到其他RST文档
如果要设置成文档超链接，像点击后可以跳转到其他RST文档：
:doc: `文档名 <地址>`

4. 内部超链接
   如果要链接到内部的文档位置，直接用 ` 标题名 ` _ 就可以跳转到文中不同级别的标题处。

网上关于RST的具体语法也有很详细的文档。

https://3vshej.cn/rstSyntax/alink.html#id2
https://zh-sphinx-doc.readthedocs.io/en/latest/rest.html

其他注意事项

• RST的表格一定要对齐，不然没办法编译成功。英文表格比较容易对齐，但是如果表格中有中文，中英文混合时会出现你看着对齐但其实没有对齐的情况。如果你是Linux系统，可以用系统自带的VIM，把表格复制进去，就可以看的很清楚哪里有没有对齐。如果没有vim，可以用等宽字体，这个我看网上有人用过，我还目前还没用过，
• RST对空格很敏感，很多格式就是因为空格引起，报错时可以重点留意下（这点和python太像了）