PandHedge

Markdown语法

2025-10-11
PandHedge

Markdown语法

概述


详情

图片的相对地址

一、核心规则:相对路径的 “参照物”

相对路径的起点是当前 Markdown 文件所在的文件夹,所有路径都基于这个 “起点” 计算。 假设你的文件结构如下(后续示例均基于此结构):

project/          # 项目根文件夹
├── docs/         # Markdown 文档所在文件夹
│   ├── guide.md  # 当前编辑的 Markdown 文件(路径起点)
│   └── images/   # 存放图片的子文件夹
│       ├── logo.png
│       └── step/
│           └── step1.png
└── cover.png     # 项目根目录的图片(不在 docs 文件夹内)

二、3 种常见场景与示例

根据图片相对于 Markdown 文件的位置,分为「同文件夹」「子文件夹」「上级文件夹」3 种情况,对应不同的路径写法。

1. 场景 1:图片与 Markdown 文件在同一文件夹

如果图片和 .md 文件直接放在一起(无需额外子文件夹),直接写图片文件名即可。 示例:若 guide.mdicon.png 都在 docs/ 文件夹下:

# 指南文档
![图标](icon.png)  # 直接写图片名

2. 场景 2:图片在 Markdown 文件的子文件夹中

图片存放在 .md 文件所在文件夹的子文件夹(如示例中的 docs/images/),路径需包含 “子文件夹名 + 图片名”。 示例 1:引用 docs/images/logo.png(1 级子文件夹):

![项目Logo](images/logo.png)  # 子文件夹名/图片名

示例 2:引用 docs/images/step/step1.png(2 级子文件夹):

![步骤1截图](images/step/step1.png)  # 子文件夹1/子文件夹2/图片名

3. 场景 3:图片在 Markdown 文件的上级文件夹中

图片存放在 .md 文件所在文件夹的 “上一级” 或更外层(如示例中的 project/cover.png,在 docs/ 的上级 project/ 中),需用 ../ 表示 “返回上一级文件夹”。

  • ../ = 返回当前文件夹的上级文件夹
  • ../../ = 返回上两级文件夹(以此类推)

示例:在 docs/guide.md 中引用 project/cover.png

![项目封面](../cover.png)  # ../ 回到上级(project/),再引用 cover.png

若图片在 “上两级” 文件夹(如 project/../other/photo.png),则路径为 ../../other/photo.png


三、特殊场景:带空格 / 特殊字符的路径

如果图片文件名或文件夹名包含空格(如 my photo.png)或特殊字符(如 # &),直接写路径可能失效,需用引号包裹路径(单引号或双引号均可)。 示例:引用 docs/images/my photo.png

![我的照片](images/"my photo.png")  # 双引号包裹带空格的文件名
# 或
![我的照片](images/'my photo.png')  # 单引号也可以

总结


上一篇 pytest

下一篇 BMC 与 BIOS

Comments

Content