图片与图表#
MyST Markdown 可用于在文档中包含图片和图表,并方便地在整个项目中引用这些图片。
1. 内联图片#
标准的 Markdown 图片语法是:
![fishy](img/fun-fish.png)
这将创建 行内 图片,显示在文本流中。
可以使用 attrs_inline 插件为行内图片添加属性:
还可以使用 html_image 扩展,允许 MyST 解析 HTML 图片标签:
2. 块级图片#
要创建 块级 图片,请使用 image
指令:
以下选项被识别:
图片选项
alt
: text替代文本:图片的简短描述,由无法显示图片的应用程序显示,或由为视障用户设计的应用程序朗读。
height
: length图片的期望高度。用于预留空间或垂直缩放图片。当同时指定“ scale ”选项时,它们会结合使用。例如,高度为 200px 且缩放比例为 50 相当于高度为 100px 且无缩放。
width
:当前行宽的 长度 或 百分比图像的宽度。用于预留空间或水平缩放图像。与上面的“高度”一样,当同时指定了“缩放”选项时,它们会结合起来使用。
scale
: 整数百分比(“%”符号可选)图像的均匀缩放比例因子。默认值为“100%”,即不进行缩放。
align
: “top”, “middle”, “bottom”, “left”, “center”, or “right”值“top”(顶部)、“middle”(居中)和“bottom”(底部)用于控制图像的垂直对齐方式。
值“left”(左对齐)、“center”(居中对齐)和“right”(右对齐)用于控制图像的水平对齐方式,使图像能够浮动并让文本环绕其周围。
target
: text (URI or reference name)将图像转换为超链接引用(“可点击”)。
class
以空格分隔的CSS类列表,用于添加到图像上。
name
用于 admonition 的引用目标(参见 交叉引用)。
4. 包含多张图像的图表#
请参阅 sphinx-subfigure 插件,了解如何创建包含多张图像的图表。