☰

在编程研讨会的演示文稿中管理代码的好方法

tag-icon • tag-icon java html presentations embedding
在编程研讨会的演示文稿中管理代码的好方法

我目前正在创建一个编程工作室（实际上它是关于 OOD 的，但这并不重要）。

我的资源主要有两种：

  • 幻灯片（HTML / reveal.js）
  • 示例项目 (Java)

在许多地方，示例项目的代码应该出现在演示文稿中。

有什么好方法可以实现这个目标？

我的要求是

  • 一种指定演示文稿中要使用的代码片段及其应出现的位置的简单方法

  • 代码中的更改会自动反映在演示文稿中（运行构建工具是可以的，但手动剪切和粘贴则不可以）

  • 断开的链接（例如尝试嵌入不存在的代码片段或标记演示文稿中未使用的代码片段应该创建警告

  • 代码与演示文稿之间存在链接可获得加分

答案1

酸医生http://asciidoctor.org/可能会解决您的大部分要求：

  • 使用纯 ASCII 写入内容
  • 包含来自真实源代码文件的代码片段
  • 构建输出时，断开的链接将产生警告
  • 在 reveal.js 和 deck.js 中创建演示文稿

你会发现https://github.com/asciidoctor/asciidoctor-gradle-examples一些如何使用 Asciidoctor 与 gradle 的示例（但其他构建工具也可以使用）。

你可以在此处浏览示例输出您将找到使用 deck.js 和 reveal.js 渲染的演示文稿（查找标有“输出”的子章节 3.4 和 9.4）

另一个灵感来源可能是 Dan Allan 的一套牌：https://github.com/mojavelinux/decks

您还要求从代码链接回演示文稿。据我所知，Asciidoctor 可以为您提供的最佳服务是，您在代码中标记代码片段的标签 ( // tag::XXX[]) 也将出现在演示文稿的源代码中 ( include::Class.java[tags=XXX])

相关内容