Landslide 项目技术文档

1. 安装指南

Landslide 是一个使用 Markdown、ReST 或 Textile 格式生成 HTML5 演示文稿的工具。以下是安装指南：

• 使用 Python 包管理器（如 pip）安装最新稳定版本的 Landslide：

  $ pip install landslide
  

• 如果你想使用最新版本：

  $ git clone https://github.com/adamzap/landslide.git
  $ cd landslide
  $ python setup.py build
  $ sudo python setup.py install
  

确保安装了以下 Python 模块：jinja2 和 pygments（用于代码块语法高亮）。可选的模块包括 watchdog（用于监视文件变化）、Prince（用于导出 PDF）。

2. 项目使用说明

Landslide 支持多种标记语言生成幻灯片：

• Markdown：文件扩展名为 .md、.markdown 等。
• ReStructuredText：文件扩展名为 .rst 或 .rest。
• Textile：使用 --- 分隔幻灯片。

生成幻灯片：

$ landslide slides.md

生成的 presentation.html 文件可以在浏览器中查看。

3. 项目API使用文档

Landslide 的命令行选项包括：

• -h 或 --help：显示帮助信息。
• -c 或 --copy-theme：将主题目录复制到当前演示文稿源目录。
• -d FILE 或 --destination=FILE：指定输出文件的路径。
• -e ENCODING 或 --encoding=ENCODING：指定文件编码。
• -i 或 --embed：将样式表和 JavaScript 内容嵌入到演示文稿中。
• -l LINENOS 或 --linenos=LINENOS：指定代码行号的显示方式。
• -o 或 --direct-output：直接输出生成的 HTML 代码。
• -q 或 --quiet：静默模式，不输出任何信息。
• -r 或 --relative：使演示文稿的资产链接相对于当前工作目录。
• -t THEME 或 --theme=THEME：指定主题名称或路径。
• -v 或 --verbose：输出详细信息。
• -w 或 --watch：监视源目录的变化并自动重新生成演示文稿。
• -x EXTENSIONS 或 --extensions=EXTENSIONS：指定 Markdown 扩展。
• -m 或 --math-output：启用数学公式输出。

4. 项目安装方式

请参考上述“安装指南”部分。

以上就是关于 Landslide 项目的技术文档，希望能够帮助用户更好地使用和理解这个项目。