llmk 项目使用教程
llmkLight LaTeX Make项目地址:https://gitcode.com/gh_mirrors/ll/llmk
1. 项目的目录结构及介绍
llmk 项目的目录结构如下:
llmk/
├── doc/
├── examples/
├── spec/
├── .gitignore
├── .ruby-version
├── Gemfile
├── Gemfile.lock
├── LICENSE
├── README.md
├── Rakefile
├── llmk-logo.png
└── llmk.lua
各目录和文件的介绍:
doc/
: 包含项目的文档文件。examples/
: 包含示例 LaTeX 文档文件。spec/
: 包含项目的规范文件。.gitignore
: Git 忽略文件配置。.ruby-version
: Ruby 版本配置。Gemfile
: Ruby 依赖管理文件。Gemfile.lock
: Ruby 依赖锁定文件。LICENSE
: 项目许可证文件。README.md
: 项目说明文件。Rakefile
: Rake 任务配置文件。llmk-logo.png
: 项目logo图片。llmk.lua
: 项目启动文件。
2. 项目的启动文件介绍
项目的启动文件是 llmk.lua
。这个文件是 llmk 的核心执行文件,负责处理 LaTeX 文档的构建任务。在使用 llmk 时,通常会通过命令 texlua llmk.lua
来启动项目。
3. 项目的配置文件介绍
llmk 支持两种配置文件:
-
llmk.toml: 这是一个独立的配置文件,用于指定 LaTeX 文档的构建设置。文件名固定为
llmk.toml
。示例内容:
latex = "xelatex" source = "hello.tex"
-
LaTeX 文档中的魔法注释: 可以在 LaTeX 文档的源文件中使用 TOML 格式的注释来指定构建设置。这些注释需要放在连续的
+
字符之间。示例内容:
% hello.tex % +++ % latex = "xelatex" % +++ \documentclass{article} \begin{document} Hello \textsf{llmk} \end{document}
通过这两种方式,可以灵活地配置 llmk 的构建任务。
llmkLight LaTeX Make项目地址:https://gitcode.com/gh_mirrors/ll/llmk