TeXdoc online
Searching TeX documentation through a simple web interface.
On this page
Introduction
TeXdoc online is an online TeX and LaTeX documentation lookup system developed and maintained by the Island of TeX. The project provides a RESTful API and a self-updating Docker container.
Primitive search indexes installed engines offline and links their reference manuals; the website offers package and primitive search modes.
The package documentation lookup relies on the Island's TeXdoc API. For topic and package listings, as well as recommendations, the system relies on the CTAN JSON API, with topic metadata cached for 12 hours and refreshed on demand.
User and deployment documentation is maintained in this repository:
- API walkthrough and examples
- Deployment and configuration
- OpenAPI specification and reference maintenance
Every built application serves a rendered API reference at /api-reference.html
and the exact source specification at /openapi.yaml. For a local server, open
the API reference.
The server is distributed as a runnable JAR and a container image.
License
The application is licensed under BSD 3-Clause.
The generated API reference includes Redoc viewer code under MIT and bundled
dependencies under their upstream licenses. Copyright and license notices are
packaged at /api-reference-LICENSE.txt and linked from the reference page.
The team
TeXdoc online is brought to you by the Island of TeX. If you want to support TeX development by a donation, the best way to do this is donating to the TeX Users Group.
Development
Use the pinned Nix shell with JDK 21, Node.js, Yarn and Chromium:
nix flake check
nix develop -c ./gradlew --no-daemon spotlessCheck detekt allTests processSmoke
nix develop .#texIntegration -c ./gradlew --no-daemon texIntegration
The default gate uses fixtures; the separate TeX gate includes a pinned TeX Live
subset. Kotlin packaged tests generate JUnit reports under root
build/test-results/ and evidence under build/reports/. Other test reports live
under each module's build/ directory.
Dependency versions are centralized in gradle/libs.versions.toml. Nix supplies
tools; Gradle manages application dependencies. See AGENTS.md for
contributor rules and reference maintenance
for documentation tasks.
Browser support
Search, package pages and topic browsing work without JavaScript. Icons are local SVGs; actions retain text when images are blocked. The API reference provides Redoc navigation with scripts enabled and the complete YAML without scripts.
Public URLs
TEXDOC_PUBLIC_URL sets the public origin independently of request Host headers.
It enables absolute canonical URLs, homepage WebSite metadata and a bounded
sitemap containing the homepage and topic index. Search pages carry noindex, follow; robots.txt permits crawling those directives. See
deployment configuration.