Marp CLI 使用教程

Marp CLI 使用教程

marp-cliA CLI interface for Marp and Marpit based converters项目地址:https://gitcode.com/gh_mirrors/ma/marp-cli

1. 项目的目录结构及介绍

Marp CLI 是一个基于命令行的工具，用于将 Markdown 文件转换为幻灯片。以下是 Marp CLI 项目的基本目录结构及其介绍：

marp-cli/
├── bin/
│   └── marp-cli
├── lib/
│   ├── cli.js
│   ├── config.js
│   └── ...
├── test/
│   └── ...
├── .gitignore
├── .npmignore
├── .prettierrc
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── package.json
├── README.md
└── ...

• bin/: 包含可执行文件 marp-cli，用于启动 Marp CLI 工具。
• lib/: 包含主要的 JavaScript 文件，如 cli.js 和 config.js。
• test/: 包含测试文件。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• .npmignore: 指定 npm 发布时忽略的文件和目录。
• .prettierrc: 代码格式化配置文件。
• CODE_OF_CONDUCT.md: 行为准则。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 许可证文件。
• package.json: 项目依赖和脚本配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

Marp CLI 的启动文件位于 bin/ 目录下，名为 marp-cli。这个文件是一个可执行的 Shell 脚本，用于启动 Marp CLI 工具。以下是 marp-cli 文件的基本内容：

#!/usr/bin/env node
require('../lib/cli.js')

• #!/usr/bin/env node: 指定使用 Node.js 运行该脚本。
• require('../lib/cli.js'): 引入并执行 lib/cli.js 文件，该文件包含了 Marp CLI 的主要逻辑。

3. 项目的配置文件介绍

Marp CLI 支持多种配置文件格式，用于配置工具的选项和行为。以下是支持的配置文件类型及其介绍：

• marp.config.js: JavaScript 配置文件。
• marp.config.mjs: ES Modules 配置文件。
• marp.config.cjs: CommonJS 配置文件。
• .marprc: JSON 或 YAML 配置文件。
• package.json: 在 package.json 文件中添加 marp 部分进行配置。

以下是一个示例 marp.config.js 配置文件的内容：

module.exports = {
  theme: 'gaia',
  options: {
    html: true,
    math: true
  }
}

• theme: 指定使用的主题。
• options: 包含各种选项，如 html 和 math。

通过这些配置文件，用户可以自定义 Marp CLI 的行为和输出格式。

marp-cliA CLI interface for Marp and Marpit based converters项目地址:https://gitcode.com/gh_mirrors/ma/marp-cli