This is the source for the official documentation of lychee, a fast, async link checker.

Requires Node.js (v18+) and pnpm.

git clone https://github.com/lycheeverse/lycheeverse.github.io.git
cd lycheeverse.github.io
pnpm install
pnpm dev

Here are some helpful commands:

• pnpm build: production build
• pnpm preview: serve the build
• pnpm lint and pnpm format: check and fix formatting and linting
• make watch or pnpm dev: watch for changes and rebuild

Documentation lives in src/content/ as Markdown/MDX. To contribute, fork the repo, make your changes on a branch, and open a pull request. For problems, open an issue.

Before opening a pull request, run pnpm precommit to check formatting and linting.