markdown文件转RST文件

2023-05-16

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

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

转化工具

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

后续调整

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

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

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

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

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

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

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

其他注意事项

  • RST的表格一定要对齐,不然没办法编译成功。英文表格比较容易对齐,但是如果表格中有中文,中英文混合时会出现你看着对齐但其实没有对齐的情况。如果你是Linux系统,可以用系统自带的VIM,把表格复制进去,就可以看的很清楚哪里有没有对齐。如果没有vim,可以用等宽字体,这个我看网上有人用过,我还目前还没用过,
  • RST对空格很敏感,很多格式就是因为空格引起,报错时可以重点留意下(这点和python太像了)
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

markdown文件转RST文件 的相关文章

  • 如何在markdown中显示本地图片?

    有谁知道如何在markdown中显示本地图像 我不想为此设置网络服务器 我在 markdown 中尝试了以下操作 但不起作用 image files Users jzhang Desktop Isolated png 我怀疑路径不正确 正如
  • 如何记录作为参数的闭包的参数

    我尝试记录函数的闭包参数 sends the request out Parameter pzurl request description including url method formdata Parameter responseP
  • R 中的 Markdown 表到数据框

    有多种方法可以将数据框转换为 Markdown 表 但是 给定 Markdown 表 如何转换回数据帧 给定一个表格 Table Header Second Header Table Cell Cell 2 Cell 3 Cell 4 或者
  • 如何使用 markdown 按顺序编写两个单独的块引用?

    我需要按顺序放置两个块引用 但是 markdown 将它们组合成一个块引用 我能让它们分开的唯一方法是在它们之间放置一些垃圾文本 由于此文本字段允许我使用 Markdown 因此我可以演示 gt First Quote gt Second
  • 如何在 vim 下突出显示 doxygen 中的 markdown?

    较新版本的 doxygen 附带了 Markdown 支持 有没有一种简单的方法可以将 Markdown 语法突出显示添加到 vim 中的 doxygen 注释块 顺便说一句 可以将 doxygen 语法添加到c文件通过使用set file
  • 如何使用PageDown Markdown编辑器?

    我想为用户提供实时预览使用 Markdown 创建的笔记的能力 但是我在该项目中找不到任何下载 我怎样才能开始使用PageDown 降价 https github com balpha pagedown编辑 PageDown 的文档非常混乱
  • 以富文本形式 Markdown 到剪贴板

    在 Windows 上使用 Python 我尝试获取一个 Markdown 文件并将其作为富文本粘贴到我的剪贴板中 大部分拼图都很简单 将 Markdown 解析为 HTML 没有问题 通过 TKinter 将内容放入剪贴板 是的 但这是我
  • gulp通过markdown json用jade生成html文件

    我在用着gulp markdown to json and gulp jade 我的目标是从 markdown 文件中获取数据 如下所示 template index jade title Europa This is a test gra
  • 在 R 中使用 knitr 和 markdown 自定义 CSS

    我发现了这个很棒的教程 介绍如何修改在 Rstudio 中使用 markdown 和 knit 创建的 HTML 报告的 css 格式 帖子可以找到here http nsaunders wordpress com 2012 08 27 c
  • 比较和对比轻量级标记语言[关闭]

    就目前情况而言 这个问题不太适合我们的问答形式 我们希望答案得到事实 参考资料或专业知识的支持 但这个问题可能会引发辩论 争论 民意调查或扩展讨论 如果您觉得这个问题可以改进并可能重新开放 访问帮助中心 help reopen questi
  • 如何在 Bitbucket wiki 上的 Markdown 中转义“@”

    谁知道如何逃脱 BitBucket wiki 上 markdown 中的字符 就我而言 后面紧跟着恰好是某人的用户名的单词 即 blahblah 到目前为止我尝试过的 64 但这些都不起作用 屏蔽被忽略 当我使用字符代码时 它只是按原样输出
  • 是否有 Swift 代码的 Github markdown 语言标识符?

    我在用着https jbt github io markdown editor https jbt github io markdown editor在线文档工具 我想知道是否有一个标识符可以识别 swift 语法元素 谢谢 swift s
  • Markdown 所见即所得编辑器和预览在同一文本区域中[关闭]

    Closed 此问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 我寻找一个编辑器来编写 Markdown 语法并在同一文本区域中预览 例如引导所见即所得HTML5 ht
  • 在 R Markdown 文件中嵌入 pdf 并调整分页

    我即将完成博士学位 我需要在 R Markdown 文本中间的某个位置嵌入一些论文 pdf 格式 将 R Markdown 转换为 PDF 时 我希望将这些 PDF 论文嵌入到转换中 但是 我希望这些 PDF 论文也根据 Markdown
  • 使用express和marked返回渲染的markdown

    因此 我正在运行一个小型测试应用程序 以在访问路线时返回 html 中的 markdown 文件的内容 我正在使用标记来呈现降价 https github com chjj marked https github com chjj mark
  • 仅在 RMarkdown 中引用作者/在文本引用中添加所有格

    我想引用 RMarkdown 中的一位作者在他的名字中添加所有格 的内容 但是 我找不到在没有出版年份的情况下引用作者或直接添加所有格的方法 s 它应该看起来像这样 在芬纳 2012 的书中 最小工作示例 对于 R 笔记本 title R
  • 使用 KnitR 在 R 中以编程方式创建 Markdown 表

    我刚刚开始了解 KnitR 以及使用 Markdown 生成 R 文档和报告 这对于我与工作有关的许多日常报告来说似乎是完美的 然而 我没有看到的一件事是使用 Markdown 格式打印数据框和表格的简单方法 有点像xtable 但使用 M
  • 如何处理 Ipython Notebook 中的引用?

    在 Ipython Notebook 中处理引用的最佳方法是什么 理想情况下 我想要一个 bibtex 文件 然后像在 Latex 中一样 在 Ipython markdown 单元格中拥有一个速记列表 并在笔记本末尾提供完整的参考文献 我
  • 有没有基于 WPF 的 Markdown 渲染器? [关闭]

    Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 我们有基于 WPF 的应用程序 我们有单独的字符串存储库 其中的文本在网络中进行编辑 在我们的 WPF
  • Pandoc Markdown 分页符

    最近我开始使用 Pandoc markdown 它似乎是 LaTeX 的一个很好的替代品 因为我的文档没有很多数学公式 而且我没有任何使用 LaTeX 的经验 再加上不到 2 周的提交截止日期 这使它成为一个很好的解决方案 我无法解决的一件

随机推荐

  • Docker安装MySQL主从配置

    今天学习Docker安装MySQL主从配置 一 Master 1 1 拉取镜像 docker pull mysql 8 0 25 1 2 新建MySQL主服务器的容器实例 xff0c 端口为3306 docker run p 3306 33
  • Jmeter测试oracle数据库

    1 oracle连接数据库 select oracle jdbc OracleDriver jdbc oracle thin 64 10 1 1 39 1521 orcl xxxx xxxx select 语句 xff1a SELECT F
  • 在32位系统上处理64位数的计算时需要注意的点

    其他人分享 xff1a 待看 https blog csdn net xhz1234 article details 8828220 stm 64位整数加减乘除时须注意的一点 qiezhihuai的博客 CSDN博客
  • Ubuntu16.04_ROS_kinetic下如何使用OpenCV2.4进行编译

    Ubuntu16 04 ROS kinetic下如何使用OpenCV2 4进行编译这一问题卡了我将近两天时间 试了网上大部分的方法但都失败了 xff0c 后来采取论坛上一个大神的方法 xff0c 直接下载opencv2的源文件作为包编译到自
  • ROS学习笔记(二)- ROS驱动机器人实例

    利用周末玩了一下先锋机器人 xff08 Pioneer3 P3AT xff09 xff0c 前后装了两次ROS xff0c 以及一大堆操作细节 xff0c 打算整理记录一下方便以后解决问题用 xff0c 同时通过实际操作 xff0c 对上一
  • 模块化程序设计——在keil中利用头文件整理程序

    模块化程序设计是指在进行程序设计时将一个大程序按照功能划分为若干小程序模块 xff0c 每个小程序模块完成一个确定的功能 xff0c 并在这些模块之间建立必要的联系 xff0c 通过模块的互相协作完成整个功能的程序设计方法 xff08 复制
  • 前端面试谈:项目经历的 STAR 法则

    大家好 xff0c 我是前端西瓜哥 xff0c 今天来看看简历中阐述项目经历的 STAR 法则是什么 STAR 法则是什么 xff1f 我们写简历中的项目经历时 xff0c 一种常见的思路就是 STAR 法则 STAR 是四个单词的首字母和
  • Promethes+grafana 监控Minio集群

    export MINIO PROMETHEUS AUTH TYPE 61 public target 中间要有空格 grafana 模板 12063 11148 13502 https grafana com grafana dashboa
  • 【开发者portal在线开发插件系列一】profile和基本上下行消息

    转载 xff1a https bbs huaweicloud com forum thread 13087 1 1 html 前言 xff1a 开发者portal支持在线开发profile xff08 即设备建模 xff09 在线开发插件
  • ubuntu安装vscode详细教程

    ubuntuvscode安装后打不开问题 这个有个坑 xff0c 有的电脑一次成功 xff0c 有的安装不了 不要下载最新版本 xff0c 下载之前的旧版本 xff1a Visual Studio Code April 2020 注意ubu
  • BC26 OPEN开发之--LWM2M连接分析

    翔神教你学NB BC26 OPEN开发之 LWM2M连接分析 前言 xff1a NB IOT商用已经2年多了 xff0c 三大运营商都建设了大量的NB网络 xff0c 尤其以中国电信最为积极 xff0c 各个模组厂家推出了大量的NB模组 x
  • STM32F429I-DISO探索第二篇 --SDRAM

    有需要STM32F429I DISCO套件的 可以点击 xff1a http item taobao com item htm spm 61 686 1000925 1000774 24 TtTrrN amp id 61 366498110
  • STM32F429I_DISCO 国外大牛做的示波器

    谷歌上搜到的 xff0c coocox网站一直打不开 xff0c 今天突然能打开了 xff0c 就下载来看了一下 xff0c 效果还是不错的 嘻嘻 下面是原帖 xff1a Oscilloscope Project for STM32F429
  • 临界区和开关中断的区别

    本篇文章是为了说明进入临界段与普通的禁止和使能中断的区别 普通的禁止和使能中断 xff0c 在禁止中断时有触发中断的事件发生 xff0c 当使能中断时该中断不会在响应 xff0c 说明普通的禁止中断是阻止了中断的发生 而在进入临界段时 xf
  • ST Nucleo mbed套件开发 一 MBED环境使用 以Nucleo-F401为例

    全球领先的半导体供应商 全球领先的ARM Cortex M微控制器厂商意法半导体 xff08 STMicroelectronics xff0c 简称ST xff09 进一步强化STM32系列微控制器的易用性和设计灵活性 xff0c 推出适用
  • 记一次失败的面试经历

    背景 xff1a 面试者 xff1a 王某 xff08 以下简称我 xff09 嵌入式行业刚入门 10年工作经历 从事方向为 xff1a GPS BD导航 xff0c 物联网 xff0c 车联网方向 面试官 xff1a 前华为员工 3年工作
  • BC26接入电信平台操作手册 (五)

    二 模块端指令操作 一 获取模块的IMEI号 AT 43 CGSN 61 1 43 CGSN 866971030545227 OK 二 查询射频开关 AT 43 CFUN 43 CFUN 1 OK 三 查询信号质量 AT 43 CESQ 4
  • Cortex M3处理器工作模式及中断过程

    1 工作模式 线程模式 xff08 Thread mode xff09 xff1a 处理器复位或异常退出时为此模式 此模式下的代码可以是特权代码也可以是用户及代码 xff0c 通过CONTROL 0 控制 处理模式 xff08 Handle
  • 命名管道和匿名管道

    我们知道进程间是可以通信的 可以达到数据传输 资源共享 事件通知 进程控制等目的 进程间通信主要包括管道 系统IPC xff0c 套接字等 管道分为三种 xff1a 普通管道 xff1a 一是单工 xff0c 只能单向传输 xff0c 二是
  • markdown文件转RST文件

    markdown 文件转RST文件时遇到的一些问题 最近需要把一些markdown文件转成RST文件 xff0c 第一次接触RST文件 xff0c 使用中会有一些语法问题需要注意 在这里做个记录 转化工具 我们可以先采用工具对整体做个初步的