KeyDown 项目技术文档

1. 安装指南

在开始使用 KeyDown 之前，请确保您的系统中已经安装了 Ruby 和 Rubygems。以下是安装 KeyDown 的步骤：

$ gem install keydown

2. 项目的使用说明

生成模板

通过以下命令生成一个示例项目：

$ keydown generate my_presentation

这将创建一个名为 my_presentation 的文件夹，其中包含以下结构：

- my_presentation/
  - css/               - Keydown CSS 和一个供您自定义的文件
  - deck.js/
  - images/            - 一些 Keydown 图片，但也可以添加您的
  - js/                - Keydown JavaScript 和一个供您自定义的文件
  - slides.md

编写 Markdown 格式的演示文稿

编辑 slides.md 文件，并以 Markdown 格式编写您的演示文稿：

!SLIDE

# 这是我的演讲

!SLIDE

## 希望您喜欢

!SLIDE code

    def foo
      :bar
    end

!NOTES

  * 确保解释 Ruby 符号的使用

!SLIDE

Google 在 [这里](http://google.com)

!SLIDE

# 问题？

!NOTE 块在生成 HTML 时将被忽略。

生成演示文稿

运行以下命令生成 HTML 演示文稿：

$ keydown slides slides.md

这会生成 slides.html 文件。

展示演示文稿

打开 slides.html 文件，在浏览器中开始您的演讲：

• 使用左右箭头键在幻灯片之间导航

3. 项目API使用文档

KeyDown 项目主要使用命令行工具与 Markdown 文件进行交互。以下是主要命令：

• keydown generate [项目名]：生成一个新的演示文稿项目模板。
• keydown slides [Markdown 文件名]：根据 Markdown 文件生成 HTML 演示文稿。

4. 项目安装方式

如前所述，KeyDown 可以通过 Rubygems 进行安装：

$ gem install keydown

确保您的系统中已安装 Ruby 和 Rubygems，然后执行上述命令即可安装 KeyDown。