如何在Markdown中添加图片:语法、示例与专业提示

本文深入探讨了在Markdown文档中嵌入图片的方法,包括基本语法、创建可点击图片、利用HTML调整图片尺寸和样式,以及Alt文本的可访问性最佳实践。旨在帮助开发者高效地在Markdown内容中处理图片展示。

阅读时长: 4 分钟
共 1714字
作者: eimoon.com

本文将探讨在 Markdown 文档中嵌入图片的基本语法、如何创建可点击图片、调整图片大小的方法,并提供关于 Alt 文本(替代文本)的最佳实践,以及在 Markdown 中使用 HTML 和内联样式处理图片展示的局限性与解决方案。

前置知识

  • 对 HTML5 有基本了解。

Markdown 图片基础语法

在 Markdown 中添加图片的基本语法如下(标题是可选的):

![Alt text](image_url "可选标题")
  • Alt text:当图片无法加载时显示的替代文本,也用于屏幕阅读器,以增强 Accessibility (可访问性)
  • image_url:图片的 URL 或本地路径。
  • "可选标题":当鼠标悬停在图片上时显示的提示文本。

示例:

![DigitalOcean 吉祥物 Boo](https://assets.digitalocean.com/articles/alligator/boo.svg "DigitalOcean 的可爱吉祥物")

上述代码将渲染为带有指定替代文本和标题的图片。

创建可点击图片

要创建可点击的图片,可以将图片语法嵌套在链接语法中:

[![Alt text](image_url)](link_url)

示例:

[![DigitalOcean App Platform](https://doimages.nyc3.cdn.digitaloceanspaces.com/002Blog/0-BLOG-BANNERS/app_platform.png)](https://www.digitalocean.com/products/app-platform)

这个例子会显示一张图片,点击该图片即可跳转到 DigitalOcean App Platform 的产品页面。

调整图片尺寸

Markdown 本身不直接支持调整图片尺寸。然而,通过内联 HTML <img> 标签,我们可以实现这一点:

<img src="image_url" width="400">

这将把图片宽度调整为 400 像素。此方法在大多数支持 Markdown 并允许嵌入 HTML 的平台(如 GitHub 和 Jupyter Notebook)上都能良好支持。

Alt 文本与可访问性最佳实践

Alt 文本(替代文本) 是对图片内容的简短描述,主要用于屏幕阅读器,帮助视障人士理解图片内容。它在图片加载失败时也很有用。一个好的 Alt 文本应该清晰、具体并与图片上下文相关,显著提升内容的 Accessibility (可访问性)

最佳实践包括:

  • 保持简洁:通常一句话即可,避免冗余。
  • 描述关键元素:重点描述图片的核心内容,而非所有细节。
  • 避免重复词语:无需使用“图片的”或“图片展示”等词语,因为屏幕阅读器会自动识别。但应提及图片类型(如“公司徽标”、“插画”或“绘画”)。
  • 避免与相邻文本重复:如果图片旁已有详细描述,Alt 文本可以更简练。

利用 HTML 和内联样式增强图片控制

尽管 Markdown 的图片语法简洁高效,但在高级样式和备用选项方面存在局限性。在这种情况下,可以直接在 Markdown 文档中嵌入原始 HTML。大多数 Markdown 处理器都支持嵌入 HTML,这在 Markdown 语法不足时提供了强大的“备用”方案。

当您需要以下功能时,应优先使用 HTML <img> 标签而非 Markdown 语法:

  • 指定精确尺寸:Markdown 不原生支持 widthheight 属性。
  • 应用复杂样式:除了基本的 Alt 文本和标题,Markdown 没有直接添加 CSS 样式(如边框、内边距或对齐)的方法。
  • 实现响应式图片:使用 <picture>srcset 根据屏幕尺寸或分辨率提供不同的图片源。
  • 添加图片说明:标准 Markdown 没有专门的说明语法。
  • 添加自定义属性:任何 Markdown 不支持的 HTML 属性(如 loading="lazy"classid 等)。

在 Markdown 中使用 HTML 还允许您使用内联 CSS 来为图片添加样式。可以通过 style 属性直接将 CSS 属性应用于 HTML 元素:

<img src="image_url" alt="Description of image" style="property: value; property2: value2;">

一些常见的内联样式示例:

  • 尺寸调整

    <img src="image.jpg" alt="A beautiful landscape" style="width: 300px; height: 200px;">
    
  • 对齐

    <img src="image.jpg" alt="A floating image" style="float: right; margin-left: 15px;">
    
  • 居中显示(需要一个包装元素):

    <div style="text-align: center;">
      <img src="image.jpg" alt="Centered image" style="display: block; margin: 0 auto;">
    </div>
    

    或者使用 <p> 标签的 align 属性(这种方式在 HTML5 中已不推荐,但许多 Markdown 渲染器仍支持):

    <p align="center">
      <img src="https://doimages.nyc3.cdn.digitaloceanspaces.com/002Blog/0-BLOG-BANNERS/app_platform.png" alt="App Platform 宣传图" width="600"/>
    </p>
    

常见问题解答 (FAQ)

1. 在 Markdown 中插入图片的正确语法是什么?

![Alt text](image_url "可选标题")

2. 如何在 Markdown 中添加本地图片?

image_url 替换为图片的本地路径,可以是绝对路径或相对路径。

  • 绝对路径![示例图片](/Users/username/Pictures/example.png)
  • 相对路径![示例图片](example.png) (图片与 Markdown 文件在同一文件夹下)

3. 我可以在 Markdown 中调整图片大小或居中显示吗?

可以通过 HTML <img> 标签实现:

  • 调整大小
    <img src="image_url" width="400" height="400">
    
  • 居中
    <p align="center"><img src="image_url" alt="居中图片" width="600"/></p>
    

4. 如何在 GitHub README 中使用图片?

  • 在 GitHub 仓库中创建一个文件夹(例如 images),将图片上传到该文件夹,然后在 Markdown 中使用相对路径:![屏幕截图](./images/screenshot.png)
  • 或者,将图片上传到首选的图床或存储桶,并使用图片的完整 URL。

总结

Markdown 简洁的语法为文档中嵌入图片提供了直接高效的方式,在简单性和功能性之间取得了平衡。虽然它能满足大部分图片需求,但在需要高级样式、特定尺寸或响应式图片技术时,直接嵌入原始 HTML <img> 标签并使用内联 CSS 可以提供更大的控制,从而实现更灵活和专业的图片展示效果。

关于

关注我获取更多资讯

公众号
📢 公众号
个人号
💬 个人号
使用 Hugo 构建
主题 StackJimmy 设计