This repo contains the website and documentation for Lynx.
Node.js >= 22pnpm(corepack enableis recommended)
Install dependencies:
pnpm installStart the dev server
pnpm run devOpen http://localhost:3000/.
pnpm run buildTo preview the production build locally:
pnpm run previewSee CONTRIBUTING.md for pull request guidelines, downstream compatibility notes, and the release cherry-pick process.
This repository is the OSS source for shared Lynx documentation, site runtime, themes, and preparation tooling. A downstream in-house documentation site consumes a pinned revision through a git submodule and layers internal-only content and configuration on top.
Changes to directly consumed content such as docs/, i18n.json, and
sharedDocs/, as well as package metadata, shared configuration contracts,
runtime source, themes, preparation scripts, or example-package layouts can
affect downstream consumers. Contributors changing this boundary must
coordinate downstream validation after the updated OSS revision is pinned.
The in-house repository synchronizes OSS changes daily at 09:30 UTC+8. For coordinated changes, especially those that must land internally first, land the downstream counterpart before the OSS change can be synchronized, or time the OSS merge around that window.
See AGENTS.md for the detailed compatibility contract and verification requirements.
/
├── docs/
│ ├── en/ # English documentation
│ ├── zh/ # Chinese documentation
│ └── public/ # Static and generated assets
├── sharedDocs/ # Generated lynx-ui documentation
│ ├── introDocs/ # lynx-ui package introductions
│ └── packageDocs/ # lynx-ui package API documentation
├── src/
│ ├── components/ # Documentation UI components
│ ├── hooks/ # Shared React hooks
│ ├── lib/ # Site runtime utilities
│ ├── luna/ # Luna integration
│ ├── lynx-ui/ # lynx-ui site runtime
│ └── styles/ # Global styles
├── theme/
│ └── lynx-ui-home/ # Rspress theme and lynx-ui homepage
├── packages/
│ ├── lynx-cdp/ # CDP documentation generator
│ ├── lynx-compat-data/ # Lynx compatibility data
│ ├── lynx-example-packages/ # Core example dependencies
│ ├── lynx-living-spec/ # Lynx living specification
│ ├── lynx-ui-example-packages/ # lynx-ui example dependencies
│ └── lynxtron-example-packages/ # Lynxtron example dependencies
├── plugins/
│ └── llms-postprocess/ # Local Rspress LLMs plugin
├── scripts/ # Prepare and documentation tooling
├── functions/ # Deployment middleware
├── rspress.config.ts # Site build configuration
├── shared-route-config.ts # Shared route contracts
├── shared-og-config.ts # Shared Open Graph contracts
└── tailwind.config.js # Shared Tailwind configuration
lynx-website uses the following third-party libraries and more. Thanks to all the contributors of these libraries:
| Name | Description |
|---|---|
| Rspress | A fast Rsbuild-based static site generator. |
| React | A JavaScript library for building user interfaces. |
| Radix UI | Components, icons, colors, and templates for building high-quality, accessible UI. |
| Semi UI | A modern, comprehensive, flexible design system and React UI library. |
| Tailwind CSS | A utility-first CSS framework. |
This Lynx-website is powered by Netlify.