lychee Documentation

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

Quick Start

Prerequisites

• Node.js (v18+)
• pnpm package manager

Development

# Clone the repository
git clone https://github.com/lycheeverse/lycheeverse.github.io.git

# Install dependencies
pnpm install

# Start local dev server
pnpm dev

Contributing

We welcome contributions! Here's how to help:

Report Issues

Found a problem? Check if it's already been reported in our issues. If not, create a new issue.

Submit Changes

1. Fork the repository
2. Create a feature branch
3. Make your changes (fix typos, broken links, etc.)
4. Submit a pull request

Project Structure

├── src/
│   ├── assets/          # Images and static files
│   └── content/         # Documentation pages (Markdown/MDX)
├── astro.config.mjs     # Astro configuration
└── package.json