UD5工具箱
使用教程
以下将为您详细介绍如何使用 Markdown 转 reStructuredText 工具完成文档格式转换。整个过程无需安装任何软件，只需一个现代浏览器即可完成。
第一步：打开工具页面
在浏览器地址栏输入工具页面地址，或通过 UD5 工具箱首页导航进入 Markdown 转 reStructuredText 工具页面。推荐使用 Chrome、Firefox、Edge 等现代浏览器，以获得最佳的实时转换体验。页面加载后，您可以看到左右对称的双栏布局，左侧为 Markdown 输入区，右侧为 reStructuredText 输出区。
提示：建议将工具页面添加到浏览器书签，方便日后快速访问。如果需要频繁使用，也可以将页面固定在浏览器标签栏中。
第二步：了解界面布局
工具页面采用直观的双栏对照布局设计：
- 左侧输入区 — 标注为 Markdown 输入的文本编辑区域，在此输入或粘贴 Markdown 格式的文档内容
- 右侧输出区 — 标注为 reStructuredText 输出的展示区域，实时显示转换后的 rST 格式内容
- 工具栏 — 页面上方提供转换、复制、下载、交换、清空、示例等功能按钮
- 状态栏 — 显示当前输入的字符数和行数，帮助您掌握文档规模
第三步：输入 Markdown 内容
在左侧 Markdown 输入区域中输入或粘贴您需要转换的 Markdown 格式文档。您可以使用以下方式添加内容：
- 直接键入 — 在输入区域中直接编写 Markdown 格式的文档内容
- 粘贴内容 — 从其他编辑器中复制已有的 Markdown 文本，粘贴到输入区域
- 加载示例 — 如果您想先体验工具功能，可以点击工具栏中的示例按钮，系统将自动加载预置的 Markdown 示例内容
键盘快捷键：使用 Ctrl+Enter 可以手动触发转换（通常情况下实时转换已自动启用，此快捷键作为备用方案）。
第四步：查看实时转换结果
当您在左侧输入 Markdown 内容时，右侧的 reStructuredText 输出区域会自动、实时地显示对应的转换结果。您可以直观地对比两种格式之间的语法差异：
- Markdown 的 # 标题被转换为带装饰线的 rST 标题
- Markdown 的围栏式代码块被转换为 .. code-block:: 指令
- Markdown 的链接语法被转换为 rST 的反引号内联链接格式
- Markdown 的表格语法被转换为 rST 的网格表格指令
通过这种左右对照的方式，您可以在转换的同时学习和理解两种标记语言之间的语法对应关系。
第五步：使用辅助功能
工具提供了一系列便捷的辅助功能，帮助您高效完成转换任务：
复制结果
点击复制按钮，转换后的 rST 内容将被复制到系统剪贴板。您可以直接粘贴到 .rst 文件或任何文本编辑器中。
下载文件
点击下载按钮，系统将把转换结果保存为 .rst 文件到您的浏览器默认下载目录。文件采用 UTF-8 编码，可直接用于 Sphinx 项目。
内容交换
点击交换按钮，右侧的 rST 内容将被移动到左侧输入区，方便您进行逆向转换或格式对比分析。
清空内容
点击清空按钮，左右两侧的内容将被同时清除。当您需要转换新的文档时，可以一键重置工作区。
第六步：转换到 Sphinx 项目
如果您需要将转换结果用于 Sphinx 文档项目，可以按以下步骤操作：
- 在工具中完成 Markdown 到 rST 的转换
- 点击下载按钮获取 .rst 文件，或复制 rST 内容
- 将文件放入 Sphinx 项目的 docs 目录中
- 在 conf.py 的 toctree 指令中添加新文件
- 运行 sphinx-build 构建文档，确认渲染效果
使用注意事项
- 转换结果应作为初始起点，复杂的文档结构可能需要根据实际需求进行手动微调
- rST 的标题装饰线长度必须与标题文本等长，请在转换后确认装饰线是否符合项目规范
- 部分 Markdown 扩展语法（如任务列表、脚注）可能无法完美转换，建议对照 rST 文档规范进行调整
- 转换过程完全在浏览器本地执行，关闭页面后输入内容不会被保留，建议提前保存重要文档