30 个版本 (8 个稳定版)
| 1.1.5 | 2023年1月11日 |
|---|---|
| 1.1.4 | 2022年12月26日 |
| 1.1.3 | 2022年9月22日 |
| 1.1.1 | 2022年5月24日 |
| 0.10.0 | 2021年7月30日 |
#1275 在 命令行工具
每月80 次下载
59KB
1.5K SLoC
Reveal.yaml
Rust 实现的 Reveal.js YAML 服务器，一个命令行界面 (CLI) 工具。
此管理器下载最新的 Reveal.js 存档以提供服务和打包功能，并拥有与 Reveal.js 相同的许可证。
gh-pages 上的静态演示： https://kmolyuan.github.io/reveal-yaml-rs
YAML 1.2 后端： https://github.com/KmolYuan/yaml-peg-rs (由我自己托管)
旧版 Python 版本是什么？
该项目是从 Python 语言迁移过来的，因此您可能在 PyPI 上找到它。Reveal.yaml 现在以更易于维护和发布的方式运行，并且是 Rust。一些旧功能可能已弃用，一些功能已改进。为什么我应该使用这个？
| 源代码 | 输出 |
|---|---|
| YAML + 媒体（图片/视频） | HTML 幻灯片（静态）/ 展示 |
您是否曾经使用 Reveal.js 与 Markdown 一起使用，但仍然难以维护 HTML 幻灯片？这项工作为您提供了干净的 YAML 幻灯片文件、自动生成的大纲、简单的布局功能、对原始 Reveal.js 功能的强大支持，以及在编辑时的实时演示。
与之前的工作相比，Markdown到HTML的转换现在是通过这个解析器完成的，而不是使用markdown.js，因此不再需要HTML转义，因为它们已经得到了足够的处理。除了在代码块中递归使用Markdown之外，您还需要自己使用<code>标签。
如果您还没有决定，请参阅文档以获取更多信息。
安装
从GitHub发行版下载CLI可执行文件：https://github.com/KmolYuan/reveal-yaml-rs/releases/
无论二进制文件放置在哪里，它都应该对环境变量PATH可见。
如果您是Rust用户，可以使用cargo进行安装。遗憾的是，二进制文件是用cargo工具链构建的，所以您得到的大小会比CI/CD结果大。
cargo install reveal-yaml
建议直接下载GitHub发行版以节省您的时间。例如，CI/CD脚本可以写成
wget -O reveal-yaml.zip https://github.com/KmolYuan/reveal-yaml-rs/releases/latest/download/reveal-yaml-linux-amd64.zip
unzip reveal-yaml.zip
chmod +x rym
./rym pack
可以使用rym命令检查可执行文件。
命令行界面
命令rym代表“Reveal-Yaml Manager”。
| 命令 | 描述 |
|---|---|
| 帮助 | 显示CLI帮助信息 |
| 更新 | 下载Reveal.js资源 |
| 新 | 创建新的项目和目录 |
| 初始化 | 从现有目录创建新的项目 |
| 服务 | 提供当前项目的服务 |
| 格式化 | 格式化当前项目 |
| 打包 | 打包当前项目 |
请参阅rym --help/rym subcommand --help获取更多信息。
编辑模式（热重载/自动重载）
在serve命令中存在-/--edit标志。此选项让服务器持续监视项目文件reveal.yaml，然后从网络浏览器重新加载页面。（通过JS & WebSocket）
如果未启用此选项，则服务器在启动时只会解析一次，并且始终使用缓存。
rym serve --edit
依赖项
~22–35MB
~626K SLoC