Lynxus: AOT-first Compile-time Java ORM

This is the public documentation site for Lynxus, an AOT-first compile-time Java ORM and pragmatic MyBatis alternative. The site is built with Astro and Starlight and deployed by GitHub Actions to GitHub Pages. The lynxus code repository is the single canonical owner of technical Markdown. This repository owns only presentation, navigation, theme, and build configuration. The workflow checks out the selected ref and builds a Pages artifact without committing the generated documentation mirror.

Cross-repository access

The lynxus source repository is public. The workflow checks it out directly at the selected branch, tag, or commit; no repository secret is required for documentation sync.

Machine-readable documentation

The build publishes /llms.txt as a concise index and /llms-full.txt as a generated plain-text mirror for search and AI agents. These files are derived artifacts; edit the canonical Markdown in lynxus instead.

Installation

npm install

Note: feel free to use the package manager of your choice.

Local Development

npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build

This command generates static content into the dist directory and can be served using any static contents hosting service.

Deployment

GitHub Actions uploads dist/ as a Pages artifact and deploys it with the official Pages actions.