TeXRocks, a minimal (La)TeX distribution
TeXRocks is a minimal (La)TeX distribution powered by Luarocks/Lux and LuaTeX.
It has the following features:
- virtual environment: all TeX packages are installed to
.lux/5.3/XXXXX-package_name@version/, like nodejs'snode_modules/and python's.venv/. After development of PDF, You can delete it safely, and it will not affect your next development of PDF. - minimal: we only install required packages
- package version control: when you declare
latex-base == "2025.06.01-1", it will install https://luarocks.org/modules/freed-wu/latex-base/2025.06.01-1 not other versions! pin the version like nodejs'spackage.jsonand python'srequirements.txt - package installation in parallel: install many packages at the same time
- a server to host compiled TeX packages: https://ustctug.github.io/texrocks/
- use lua to develop TeX packages: https://luarocks.org/m/texmf
We also provide some related TeX tools, like kpsewhich and texdef written in lua. See official website https://texrocks.readthedocs.io/
Quick Start
First coming?
- tutorial: the steps to build a TeX project
- install and configure: read it before all examples
Examples
Demos
- draw a graph: an example for LaTeX
- use bibliography: another example for LaTeX
- write markdown: try markdown!
- write a thesis for ieeetran: a complex project.
Projects
- lshort-zh-cn: The Not So Short Introduction To LaTeX2ε (Chinese Edition)
- sjtulib-latex-talk: How to use LaTeX to make a beamer
TeX Dialects
Which TeX do you want to use?
- plainTeX: first TeX
- LaTeX: most people needed TeX
- TeXinfo: GNU's TeX
- sdLuaTeX: speedata's TeX
- A toy TeX: how to create a new TeX dialect?
- ConTeXt: TODO
TeX Tools
Some useful tools for development!
Developed by others
- l3build: a tool to test/build/pack TeX packages developed by LaTeX 3 team
- light-latex-make: read XXX.log to decide if rerun TeX compiler.
- texdoc: a tool to search document of any TeX package developed by TeX Live team. It needs an extra configuration.
- luafindfont: a simple tool to search fonts
Developed by ours
- texdef: which TeX package defines
\macro? - epstopdf: call ghostscript to convert eps to pdf
- texcat: a new syntax highlight system to replace minted based on python's pygments
- luarocks-build-l3build: Luarocks build backend for packing TeX packages. More TeX packages are needed: CTAN ~3000 v.s. https://ustctug.github.io/texrocks/ ~100. Welcome to pack!
Learn More
Know what is under the hood.
- Structure: What does it consist of?
- Principle: How does it work?
- Roadmap: which features TeXRocks have supported and will support?
Others
- manifest: list all current TeX packages
- rocks: some packages cost many time to build. We provide compiled packages for them!
- repository: git repository, also include this website.
- CTAN: CTAN homepage
Related Projects
- mmTeX: the earliest plainTeX distribution.
- aplTeX: inspiration source
- TinyTeX: a small customized TeX Live fork.
- TeX Live: official (La)TeX distribution
- MikTeX: another famous (La)TeX distribution
Modules
API reference for developers| texrocks | utilities |
| texrocks.kpsewhich | library for kpsewhich |
| texrocks.lfs | wrap lfs |
| texrocks.luatex | library for luatex, lualatex, luatexinfo and initex |
| texrocks.os | wrap os |
| texrocks.texlua | library for texlua |
| texrocks.tlmgr | library for tlmgr |
| texrocks.updmap | library for updmap |
| epstopdf | library for epstopdf |
| rpzip | https://github.com/drivendataorg/repro-zipfile/pull/23 |
| sdluatex | library for sdluatex |
| texdef | library for texdef and latexdef |