Slide 幻灯片语法¶
预计阅读时长 : 6 分钟
使用 Markdown 来制作幻灯片,听起来有点像是在炫技,但实际上效果还真的挺不错的。
Marp ⧉ 是一个基于 Markdown 的简单幻灯片制作工具,由于其语法简单,非常适合用来制作一些简单的幻灯片。
相比 Marp,Reveal.js ⧉ 的语法要复杂一些,但是功能也炫酷的多。
虽然 Reveal.js 本身基于 HTML,但是在第三方插件的支持下,我们也可以使用 Markdown 来书写 Reveal.js 的演示文稿。
在最佳实践中,我们可以用 Marp 来完成草稿的写作,然后使用 Reveal.js 来完成最终的美化排版。
系统配置¶
首先,我们需要在 Cursor 中安装两个插件,以便在 Cursor 中预览 Marp 和 Reveal.js 的幻灯片效果。
Marp 使用¶
激活预览¶
为了能在 Cursor 中的 Markdown 预览中展示 Marp 的幻灯片效果,我们需要在 Markdown 文件的顶部添加一个 YAML 头信息,来激活预览。
激活预览 | |
---|---|
基本语法¶
Marp 的语法称为 Marpit Markdown ⧉。 由于我们只将 Marp 用作草稿使用,所以在这里只需要使用一些最基本基本的语法。
首先,我们可以使用 ---
来分隔不同的幻灯片。需要注意的是,在分隔符前一定要保留一个空行才能正确解析。
其次,我们可以使用 #
来定义标题,一共支持 6 级标题。常用的 Mardown 语法文本,例如 **
和 _
等,以及引用、列表、链接、图片等都可以正常使用。
最后,就没有最后了。毕竟我们只是打个草稿,效果美化的事情,还是交给 Reveal.js 来完成吧。
Reveal.js 使用¶
激活预览¶
Reveal.js Markdown 格式文本的配置是通过 Yaml 来实现的,全部的配置项可以参考 vscode-reveal Yaml ⧉中的说明。
我们可以直接在 Markdown 文件的 YAML 头的信息中继续添加相应的 Reveal.js 配置属性项来进行相关的配置,通过这种方式配置的最好一点是,可以和 MkDocs 的文档配置方式完全兼容,不会因为配置问题导致本地和线上的冲突。
基本语法¶
Reveal.js 的通过插件支持 Markdown ⧉。由于支持的语法较多,我们通过一个官方 ⧉来展示其基本语法。
线上部署¶
由于 vscode-reveal 在最精简版本 reveal.js 中的基础上添加了很多的插件功能,因此我们无法使用类似 reveal-md ⧉ 这样的服务来直接进行渲染,会出现部分语法不支持的问题。
所以,我们需要使用 vscode-reveal 插件自带的 export to html
功能来生成完整的幻灯片 HTML 文档。然后,将生成的 HTML 文档上传到服务器,通过 Nginx 的反向代理或者其他静态文件服务,即可实现幻灯片的线上预览。