前置知识: Markdown

Markdown 链接与图片

7 minIntermediate

行内链接、引用链接、图片嵌入与脚注。

语法[链接文本](URL "可选的标题") 示例

[GitHub](https://github.com 'GitHub 官方网站')
[Markdown 指南](https://www.markdownguide.org)

渲染效果GitHub Markdown 指南

语法

[链接文本][引用标识符]
[引用标识符]: URL "可选的标题"

示例

[GitHub][github]
[Markdown 指南][md-guide]
[github]: https://github.com "GitHub 官方网站"
[md-guide]: https://www.markdownguide.org "Markdown 官方指南"

渲染效果: [GitHub][github] [Markdown 指南][md-guide] [github]: https://github.com “GitHub 官方网站” [md-guide]: https://www.markdownguide.org “Markdown 官方指南”

语法<URL><电子邮件地址> 示例

<https://github.com>
<example@example.com>

渲染效果https://github.com example@example.com

语法:使用相对路径指向本地文件或目录 示例

[README 文件](./README.md)
[图片目录](../assets/)

渲染效果README 文件 图片目录

2. 片 (Images)

2.1 基本语法

语法![替代文本](图片URL "可选的标题") 示例

!

渲染效果GitHub Logo

2.2 引用

语法

!
[图片引用标识符]: 图片URL "可选的标题"

示例

!
[github-logo]: https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png "GitHub Logo"

渲染效果: ![GitHub Logo][github-logo] [github-logo]: https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png “GitHub Logo”

2.3 本地

语法:使用相对路径指向本地片文件 示例

!

2.4 片链接

语法:将片嵌套在链接中 示例

[![GitHub Logo](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)](https://github.com)

渲染效果GitHub Logo

3. 最佳实践

3.1 链接最佳实践

  1. 使用描述性的链接文本:链接文本应该清晰地描述链接的目标,避免使用”点击这里”等模糊描述
  2. 添加标题属性:对于重要的链接,添加标题属性可以提供更多上下文信息
  3. 使用引用链接:对于重复使用的链接,使用引用链接可以使代码更整洁
  4. 检查链接有效性:定期检查链接是否仍然有效

3.2 片最佳实践

  1. 添加替代文本:为片添加有意义的替代文本,提高可访问性
  2. 优化图片大小:确保片大小适中,避免影响页面加载速度
  3. 使用相对路径:对于本地片,使用相对路径可以确保在不同环境中都能正确显示
  4. 添加图片标题:对于复杂片,添加标题可以提供更多信息

3.3 组织片资源

  1. 创建专门的图片目录:如 assets/images/ 目录
  2. 使用一致的命名规范:如 feature-image.pngstep-1-screenshot.png
  3. 分类存储:根据用途或主题对片进行分存储

4. 常见问题与解决方案

4.1 片不显示

问题片无法正常显示 解决方案

  • 检查片路径是否正确
  • 确保片文件存在
  • 检查网络连接是否正常
  • 对于本地片,确保使用正确的相对路径

4.2 链接失效

问题:链接点击后无法访问目标页面 解决方案

  • 检查 URL 是否正确
  • 确保目标网站仍然存在
  • 对于本地文件,确保文件路径正确
  • 检查是否需要添加 http://https:// 前缀

4.3 片大小控制

问题片显示过大或过小 解决方案

  • 在 Markdown 中,基本语法不支持直接控制片大小
  • 可以使用 HTML 标签来控制片大小:
<img src="image.png" alt="描述" width="300" height="200" />
  • 或者在 CSS 中设置片样式

5. 扩展语法

5.1 GitHub Flavored Markdown (GFM)

任务列表

-
-
-

渲染效果

  • 完成任务 1
  • 完成任务 2
  • 完成任务 3

5.2 表格中的链接和

示例

| 名称   | 链接                         | 图标                                                                                 |
| ------ | ---------------------------- | ------------------------------------------------------------------------------------ |
| GitHub | [GitHub](https://github.com) | ![GitHub](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png) |
| Google | [Google](https://google.com) | ![Google](https://www.google.com/favicon.ico)                                        |

渲染效果

名称链接
GitHubGitHubGitHub
GoogleGoogleGoogle

6. 总结

Markdown 提供了简洁而强大的语法来添加链接和片,使文档更加丰富和有吸引力。通过掌握这些语法,你可以创建包含外部链接、内部链接、片和片链接的文档。 在使用链接和片时,遵循最佳实践可以确保文档的可访问性、可靠性和美观度。同时,了解常见问题的解决方案可以帮助你快速解决在使用过程中遇到的问题。


更新日志 (Changelog)

  • 2026-04-05: 整合 Markdown 链接与片知识
  • 2026-04-05: 扩写内容,增加详细的链接型、片语法、最佳实践和常见问题