首页
/ Marp-CLI 中如何自定义资源文件的基础路径

Marp-CLI 中如何自定义资源文件的基础路径

2025-07-03 17:38:11作者:霍妲思

在 Marp-CLI 项目中,用户经常需要处理与 Markdown 文件不在同一目录下的资源文件(如图片等)。本文将详细介绍如何通过 CLI API 的 baseUrl 参数来实现这一需求。

基础路径配置原理

Marp-CLI 提供了通过设置 baseUrl 来指定资源文件基础路径的功能。这个功能基于 HTML 的 <base> 元素原理实现,它会改变文档中所有相对 URL 的解析基准。

具体实现方法

在 JavaScript 代码中,可以通过以下方式使用这个功能:

import { marpCli } from '@marp-team/marp-cli'

await marpCli(['example.md'], {
  baseUrl: 'file:///path/to/resources/example.md'
})

在这个示例中:

  1. 所有 Markdown 中的资源引用都将以 file:///path/to/resources/example.md 为基准路径进行解析
  2. 例如 ./image.png 这样的相对路径将被解析为 file:///path/to/resources/image.png

实际应用场景

这个功能在以下场景特别有用:

  1. 当 Markdown 文件和资源文件存放在不同的目录结构中时
  2. 在构建自动化流程中需要统一资源路径时
  3. 在 VS Code 等编辑器插件中集成 Marp 功能时

注意事项

  1. 该功能目前仅作为 CLI API 选项提供,没有直接暴露给命令行接口
  2. 使用 file:// 协议时需要注意操作系统的文件路径格式差异
  3. 设置错误的 baseUrl 可能导致资源无法加载,需要仔细检查路径配置

通过合理使用 baseUrl 参数,开发者可以更灵活地管理 Markdown 演示文稿中的资源文件路径,适应各种项目结构和部署需求。

登录后查看全文
热门项目推荐
相关项目推荐