Polylux 使用手册

Polylux 使用手册

polylux A package for creating slides in Typst 项目地址: https://gitcode.com/gh_mirrors/po/polylux

---

1. 项目目录结构及介绍

Polylux 是一个基于Typst的演示文稿制作包，旨在提供类似于LaTeX Beamer的功能。以下是Polylux项目的基本目录结构示例及其简介：

• src
  此目录包含了Polylux的核心代码。它定义了如何生成动态幻灯片、主题风格以及各种辅助函数。

• docs
  文档部分，可能包含项目的手册、API文档或者如何使用的指南。

• examples
  提供一些示例文件，帮助用户快速理解如何使用Polylux来创建演示文稿。

• theme
  包含不同的主题样式，如Simple、Clean、Metropolis等，用户可以根据这些预设的主题来定制自己的演示外观。

• LICENSE
  许可证文件，声明Polylux遵循MIT许可协议。

• README.md
  项目的入门指南，简要介绍了项目的目的、安装方法以及快速启动步骤。

2. 项目的启动文件介绍

在Polylux中，并没有传统意义上的单一“启动文件”。然而，对于用户而言，通常的“启动”过程是从创建一个新的.tex文件（尽管是Typst的文件但习惯上这么称呼）开始的，这可以视为用户的入口点。这个文件将导入Polylux包并开始定义幻灯片的内容。例如，一个简单的启动文件可能看起来像这样：

import polylux

slide {
  titlepage
}

在此，import polylux引入了Polylux包，随后定义了一个简单的幻灯片用于展示标题页。

3. 项目的配置文件介绍

Polylux的配置不通过独立的配置文件进行，而是通过在Typst脚本中直接设置选项来实现。配置主要通过导入Polylux后的命令或在幻灯片内部直接指定参数来完成。例如，选择不同的主题或自定义动态效果时，你可能会写入类似以下的配置指令：

use theme "Clean"
slide {
  style = { background.color = white }
  ...
}

这里的use theme "Clean"选择了“Clean”主题，而style属性则是对单个幻灯片或全局的样式调整。

总的来说，Polylux鼓励在代码中灵活配置而非依赖外部配置文件，使得每个演示文稿都能紧密结合其特定需求进行定制。

---

请注意，具体文件路径和名称可能需参照实际克隆的仓库中的最新布局，上述结构和说明基于开源项目的一般组织方式和提供的信息进行概括。

polylux A package for creating slides in Typst 项目地址: https://gitcode.com/gh_mirrors/po/polylux