Skip to content

README.md

Latest commit

 

History

History
33 lines (23 loc) · 1.83 KB

README.md

File metadata and controls

33 lines (23 loc) · 1.83 KB
Raw

lychee docs

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

Links Code Quality PR Links Deploy Built with Starlight

Development

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

Contributing

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.