Marp CLI 使用教程

1. 项目介绍

Marp CLI 是一个命令行界面工具，用于基于Marpit构建Markdown转换器，它可以将Markdown文件轻松地转化为漂亮的幻灯片、PDF文档或者HTML页面。该项目由@marp-team维护，使用MIT许可证，支持自定义主题和配置项。

2. 项目快速启动

安装

首先，确保你的系统已经安装了Node.js。然后，可以通过npm来全局安装Marp CLI：

npm install -g @marp-team/marp-cli

转换Markdown文件

一旦安装完成，你可以尝试将Markdown文件转换为PDF：

npx @marp-team/marp-cli input.md --pdf --output output.pdf

这将会把名为input.md的Markdown文件转换成output.pdf。

快照模式

若要快速查看Markdown文件的预览，使用-w或--watch参数：

npx @marp-team/marp-cli --watch input.md

这会在文件变化时实时更新预览。

3. 应用案例和最佳实践

自定义主题

为了使用自定义CSS主题，你需要先创建一个CSS文件，然后通过--theme选项指定：

npx @marp-team/marp-cli input.md --theme custom-theme.css

配置文件

为了全局设置默认选项，可以创建一个marprc(JSON或YAML)或者marp.config.{js,mjs,cjs}文件。

例如，创建一个marprc.yaml文件：

theme: gaia
pdf:
  margin-top: 2cm

然后在命令中省略相关选项，Marp CLI将自动读取这些配置。

4. 典型生态项目

• Marpit: Markdown呈现引擎，是Marp CLI的基础。
• Marp: GUI应用程序，提供了更直观的用户界面。
• Docker Image: marpteam/marp-cli官方Docker镜像，方便在无Node.js环境下的使用。

更多关于Marp CLI的信息，包括API使用和配置选项，可以参考其官方GitHub仓库中的README文档和CONTRIBUTING指南。

---

以上就是Marp CLI的基本使用及一些实用技巧，希望对你有所帮助。如需进一步探索，请访问项目主页：https://github.com/marp-team/marp-cli。