Markdown 支持
Markdown 是一种轻量级标记语言,用于为纯文本添加格式元素。 PyCharm 可识别 Markdown 文件,提供带有高亮、补全和格式设置的专用编辑器,并在实时预览窗格中显示渲染后的 HTML。 支持基于 CommonMark 规范。
创建新的 Markdown 文件
默认情况下,PyCharm 会将具有 .md 或 .markdown 扩展名的任何文件识别为 Markdown 文件。
在 项目 工具窗口 Alt+1 中右键点击某个目录,并选择 。
或者,您可以选择所需目录,按 Alt+Insert ,然后选择 文件。
为您的文件输入一个带有可识别扩展名的名称,例如: readme.md 。
Markdown 编辑器在您选择文本片段时会显示的 浮动工具栏 中提供若干基本格式化操作。 您可以使用 预览窗格 查看渲染后的 HTML。
当前 项目 中的文件链接也支持 补全 ,例如,当您需要引用源代码、图像或其他 Markdown 文件时。 有关详细信息,请参阅 链接。
代码块
要插入围栏代码块,请在代码块前后使用三个反引号 ```。 如果您为代码块指定了语言,默认情况下,Markdown 编辑器会 注入相应语言。
这将为指定语言启用语法高亮和其他代码辅助功能: 补全、 检查、 意图操作。

您可以使用 doctest 注入在 REPL 模式下演示执行 Python 代码:

在代码块中禁用代码辅助
如果您的代码块不要求语法正确,您可能希望在代码块中禁用代码注入和语法错误提示。
按 Ctrl+Alt+S 打开设置,然后选择 。
清除以下选项:
在代码隔离中注入语言
显示代码隔离中的问题
点击 确定 应用更改。
从 Markdown 文件运行命令
克隆项目时,通常会有一个 README.md 文件,其中包含运行应用、配置环境等说明和命令。 PyCharm 会检测这些命令,并提供用于运行命令的标记栏图标。
在光标位于您要运行的命令处时,点击相应的标记栏图标或按 Ctrl+Shift+F10。
您可以在 IDE 设置 Ctrl+Alt+S 的 下禁用在 Markdown 文件中运行命令的标记栏图标:清除 检测可以直接从Markdown 文件运行的命令 复选框。
有关详细信息,请参阅 Markdown 语言设置。
图表
Markdown 编辑器可以渲染使用 Mermaid 和 PlantUML 定义的图表。 默认情况下,此功能处于禁用状态,需要执行其他步骤。

启用 Mermaid 图表支持
按 Ctrl+Alt+S 打开设置,然后选择 。
查找并安装 Mermaid 插件。
启用 PlantUML 图表支持
按 Ctrl+Alt+S 打开设置,然后选择 。
在 Markdown 扩展 下安装并启用 PlantUML。
在 PyCharm 下载相关扩展后,点击 确定 应用更改。
HTML 预览
默认情况下,Markdown 编辑器会在 Markdown 源旁边显示用于渲染 HTML 代码的预览窗格。 您可以在 Markdown 编辑器的右上角点击 编辑器 或
预览 ,仅显示编辑器或预览窗格。
水平拆分编辑器和预览
默认情况下,编辑器和预览垂直拆分(并排),这对于宽屏显示器更为方便。 您也可以将其水平拆分,使预览显示在编辑器的下部,这对于纵向显示器更为方便。
在编辑器的右上角,点击
打开 编辑器预览 窗格。
点击
,将编辑器与预览水平拆分。

要配置预览的默认布局,您可以在 中使用 预览布局 列表。
禁用编辑器与预览滚动条同步
默认情况下,编辑器与预览窗格中的滚动条是同步的,这意味着预览窗格中的位置与源中的位置相对应。
按 Ctrl+Alt+S 打开设置,然后选择 。
清除 在编辑器和预览中同步滚动。
点击 确定 应用更改。
更改预览字体大小
尽管您可以通过 自定义 CSS来定义预览的字体大小,但也可以为内置样式表设置字体大小。
按 Ctrl+Alt+S 打开设置,然后选择 。
在 预览字体大小 字段中设置字体大小。
点击 确定 应用更改。
如果您经常需要调整预览字体大小,建议为以下两个操作分配快捷键,而不是在设置中更改: 增大预览字体大小 和 减小预览字体大小。
自定义 CSS
PyCharm 提供用于在预览窗格中渲染 HTML 的默认样式表。 这些样式表旨在与默认的 UI 主题保持一致。 您可以配置特定 CSS 规则,以进行小幅呈现更改,例如更改标题的字体大小或列表的行距。 或者,您可以提供全新的 CSS,以更好地匹配您的预期输出,例如,如果您希望复刻 GitHub Markdown 样式。
配置用于渲染 HTML 预览的 CSS
按 Ctrl+Alt+S 打开设置,然后选择 。
在 自定义CSS 下进行配置:
选择 加载自 ,指定自定义 CSS 文件的位置。
选择 CSS 规则 规则,输入您想要覆盖的特定 CSS 规则。
点击 确定 应用更改。
以下是自定义 CSS 规则示例:
图像
默认情况下,Markdown 使用以下图像语法,您可以借助当前 项目 内路径的补全自行输入:

插入图像
按 Ctrl+U。
或者,按 Alt+Insert 打开 插入… 弹出窗口,然后选择 图像。

在 插入图像 对话框中指定图像路径。

点击 确定。
要配置图像,请在插入图像的行的标记栏中点击 。 例如,您可以在 插入图像 和 配置图像 对话框中选择 转换为HTML ,以使用原始 HTML 在 Markdown 文件中插入图像。

这将产生以下内容:

链接
您可以使用以下语法定义链接:

插入链接
按 Ctrl+Shift+U。
或者,按 Alt+Insert 打开 插入… 弹出窗口,然后选择 链接。

如果您已高亮显示某些文本,它会被括在 [ ] 中,作为链接文本。 如果您已将 URL 复制到剪贴板,它会被括在 ( ) 中,作为链接 URL。
可选标题会在您将鼠标悬停在链接上时显示。
链接到其他文件和标题
除了 URL,您还可以添加指向当前文件中任意标题的链接:
# This is a chapter Link to [this chapter](#this-is-a-chapter)您还可以链接到相对于当前文件的任意其他文件:
# This is a chapter Link to [a chapter in another file](another-file.md#some-chapter)
PyCharm 为当前上下文中可用的链接标签提供补全:相对于当前文件的文件以及有效的标题标签。
在链接标签上按 Ctrl+Click ,导航到被引用的标题。
您可以在标题或标签上调用 查找用法(U) Alt+F7 ,以查看所有指向该标签的链接。 您还可以在标题或标签上调用 重命名 重构 Shift+F6 ,以将其与所有相关用法一起重命名。
生成目录
您可以生成当前文件中可用标题的正确缩进列表。
将光标放在您希望为当前文件添加目录的位置,按 Alt+Insert 打开 插入… 弹出窗口。
选择 目录。

如果该文件中已存在目录,选择 更新目录 以在添加、删除或重命名某些标题后进行更新。
目录包含在 <!-- TOC --> 注释标记中。
表格
PyCharm 支持在 Markdown 中创建和编辑表格。
插入表格
按 Alt+Insert 打开 插入… 弹出窗口,然后选择 表。

选择表格大小(行数和列数)。
输入每个单元格的内容,按 Tab 将光标从一个单元格移动到下一个单元格。 要添加新行,按 Shift+Enter。 在您键入时,PyCharm 会自动调整行和列,以恰当地适应表格单元格中的内容。
有关在编辑表格时禁用辅助功能的信息,请参见 智能键: Markdown
PyCharm 会突出显示任何格式不正确的表格,并允许您进行修复。 当您从列表中选择快速修复时,PyCharm 会显示应用该快速修复后结果的预览。

默认情况下,PyCharm 会在编辑器中显示表格列和行标记。 使用这些标记可选择、移动、插入、移除并对齐列和行。 这些标记是特定于 Markdown 文件的一种特殊类型的 内联提示。 如果您没有看到这些标记,按 Ctrl+Alt+S 打开 IDE 设置,转到 ,并选中 选项。

点击列标记以执行以下操作:
向左移动列
向右移动列
在左侧插入列
在右侧插入列
选择列单元格
左对齐
居中对齐
右对齐
移除列
点击行标记以执行以下操作:
向上移动行
向下移动行
在上方插入行
在下方插入行
选择行
移除行
数学表达式
Markdown 插件支持使用 TeX 和 LaTeX 语法向文档添加数学表达式。 使用单个美元符号 $...$ 表示行内数学公式,使用双美元符号 $$...$$ 表示数学块。

如果您想插入美元符号字面量,请使用反斜杠进行转义: \$ 或 \$$。
浮动工具栏
当您在 Markdown 文件中选择某些文本时,PyCharm 会显示包含各种格式选项的浮动工具栏。

在普通文本与从 H1 到 H6 级别的标题之间进行选择。
粗体 Ctrl+B
斜体 Ctrl+I
删除线 Ctrl+Shift+S
代码 Ctrl+Shift+C
创建链接 Ctrl+Shift+U
无序列表
有序列表
复选标记列表

自定义浮动工具栏
按 Ctrl+Alt+S 打开设置,然后选择 。
在 Markdown 编辑器浮动工具栏 下添加或移除所需的操作。
有关详细信息,请参阅 菜单和工具栏。
点击 确定(O) 应用更改。
隐藏浮动工具栏
按 Ctrl+Alt+S 打开设置,然后选择 。
在 Markdown 下选择 隐藏浮动工具栏。
点击 确定(O) 应用更改。
重新格式化 Markdown 文件
PyCharm 可以对 Markdown 文件进行 重新格式化 ,应用适当的换行、空行和缩进。
您可以在 VCS 提交、运行构建或执行其他操作时自动触发重新格式化,也可以随时手动调用:
在主菜单中,转到 或按 Ctrl+Alt+L。
PyCharm 会根据 Markdown 文件的 代码样式设置对内容进行格式化。
配置 Markdown 代码样式设置
按 Ctrl+Alt+S 打开设置,然后选择 。
转换 Markdown 文件
Markdown 插件可开箱即用地将 Markdown 文件导出为 HTML 和 PDF。 如果您配置 Pandoc ,它也能够导出到 Microsoft Word 文件(DOCX)并从中导入。
配置 Pandoc
PyCharm 应能够自动检测您的 Pandoc 安装。 如果没有,请执行以下操作:
在主菜单中,转到 。
在 Pandoc 设置 下,指定 Pandoc 可执行文件的位置,以及要存储从 Microsoft Word 文档导入的图像的位置。
点击 确定 应用更改。
从 Microsoft Word 导入
在主菜单中,转到 。
指定文档的位置。
将 Markdown 文件导出为其他格式
PyCharm 可以导出到 Microsoft Word(需要 Pandoc )、PDF 和 HTML。
点击
编辑器和预览 或
预览 在编辑器中显示 HTML 预览窗格。
在主菜单中,转到 。
在 导出Markdown 对话框中,指定输出文件的名称、位置和格式,然后点击 确定(O)。

效率提示
自定义 Markdown 的高亮显示
PyCharm 会根据 配色方案设置突出显示各种 Markdown 元素。
在 设置 对话框(Ctrl+Alt+S )中,选择 编辑器 | 配色方案 | Markdown。
选择配色方案,接受从默认设置继承的高亮设置,或按照 颜色与字体 中的说明进行自定义。
在大型 Markdown 文件中导航
使用 结构 工具窗口 Alt+7 或 文件结构 弹出窗口 Ctrl+F12 查看并跳转到相关标题。
向 Markdown 文件添加注释
Markdown 没有用于注释行的专用语法。 不过,可以使用不带地址的链接标签来模拟注释行,如下所示:
将光标放在要注释的行上,然后按 Ctrl+/。
这会添加一个链接标签,将要注释的文本放在括号中,并在必要时在其前面添加一个空行。 再次按相同的快捷键可取消注释。
换行并填充段落
默认情况下,PyCharm 不会自动对长行添加硬换行。 在您 重新格式化文件时会换行。
按 Ctrl+Alt+S 打开设置,然后选择 。 配置 Markdown 代码样式设置 ,以在键入时启用自动换行。
或者,完全禁用硬换行,以保留长于已配置的最大行长度的段落。
您还可以使用 操作为光标所在的段落添加换行。