slides2pages

将 Marp 部署到 GitHub 页面

网页演示：立即！

什么？

Marp 允许您从 Markdown 创建 HTML 幻灯片（就像这样！）。

该演示文稿既是一个网站，也是一个 README.md。

为什么？

像对待代码一样对待您的演示文稿。

• 使用 git 跟踪更改
• 拉取请求进行协作
• 自动部署
• 看到问题了吗？打开一个问题！

设置

想创建自己的吗？

首先，从模板存储库创建一个新存储库。

配置 GitHub 页面

打开您的新存储库并设置发布。

您通常会使用gh-pages作为部署分支。

审查构建

单击“操作”选项卡并查看构建是否成功（可能需要一些时间）。

您现在应该在gh-pages分支中看到生成的文件。

查看网页

打开您部署的网页即可查看内容。

开箱即用后，您应该将README.md视为/index.html和/README.pdf 。 docs/下的幻灯片也会被转换。

本地运行

• 无需安装marp-cli一次性转换

$ npx @marp-team/marp-cli@latest README.md -o build/README.pdf

---

• 或者，使用npm在当前目录中安装marp-cli

$ npm install --save-dev @marp-team/marp-cli

• 运行上面的命令会在当前目录中创建一个package.json文件，如下所示

{
	"devDependencies" : {
		"@marp-team/marp-cli" : " ^4.0.0 "
	}
}

---

• 现在，当前缀为npx时， marp命令在当前目录中可用

$ npx marp README.md -o build/README.pdf

• 这是输出

[  INFO ] Converting 1 markdown...
[  INFO ] README.md = > build/README.pdf

---

• 如果当前目录中已有package.json文件，只需运行此文件即可安装它指定的包。

$ npm install

作为工作流程步骤

工作流程运行等效步骤：

 - name: Marp Build (README.pdf)
  uses: docker://marpteam/marp-cli:v1.7.0
  with:
    args: README.md -o build/README.pdf
  env:
    MARP_USER: root:root

请注意， args与上一张幻灯片相匹配。

定制构建

build/文件夹中的所有内容都将部署到 GitHub Pages。

您可以复制额外的文件或使用其他工具运行进一步的处理步骤。

了解更多关于马尔普的信息

现在是了解更多有关 Marp 的好时机。这里有一些资源：

• 通用标记
• 备忘单
• 主题
• CSS 主题
• 指令
• VS 代码插件
• 马尔普在线编辑器

示例站点

使用此操作的已知网站有：

• 伊利诺伊大学香槟分校的 CS 199 更多练习（代码）
• 探索基于代理的模型（代码）

发送拉取请求以添加您的网站。

发布您的幻灯片

当您准备好共享演示文稿时，请提交或合并到main ，GitHub Pages 上的内容将自动更新。

？

万岁！