|
1 | 1 | # lychee Documentation |
2 | 2 |
|
3 | | -This is the source code for the official documentation page of [lychee](https://github.com/lycheeverse/lychee/). |
| 3 | +This is the source code for the official documentation of [lychee](https://github.com/lycheeverse/lychee/), a fast, async link checker. |
4 | 4 |
|
5 | 5 | [](https://github.com/lycheeverse/lycheeverse.github.io/actions/workflows/check-links.yml) |
6 | 6 | [](https://github.com/lycheeverse/lycheeverse.github.io/actions/workflows/check-code-quality.yml) |
7 | 7 | [](https://github.com/lycheeverse/lycheeverse.github.io/actions/workflows/check-pr-links.yml) |
8 | 8 | [](https://github.com/lycheeverse/lycheeverse.github.io/actions/workflows/deploy.yml) |
9 | 9 | [](https://starlight.astro.build) |
10 | 10 |
|
11 | | -## Getting Started |
| 11 | +## Quick Start |
12 | 12 |
|
13 | | -To clone the repository, run |
| 13 | +### Prerequisites |
| 14 | + |
| 15 | +- [Node.js](https://nodejs.org/) (v18+) |
| 16 | +- [pnpm](https://pnpm.io/) package manager |
| 17 | + |
| 18 | +### Development |
14 | 19 |
|
15 | 20 | ```bash |
| 21 | +# Clone the repository |
16 | 22 | git clone https://github.com/lycheeverse/lycheeverse.github.io.git |
17 | 23 | ``` |
18 | 24 |
|
19 | | -## Installation |
20 | | - |
21 | | -To install the dependencies, run |
22 | | - |
23 | 25 | ```bash |
| 26 | +# Install dependencies |
24 | 27 | pnpm install |
25 | 28 | ``` |
26 | 29 |
|
27 | | -## Local Development |
28 | | - |
29 | | -To start the development server, run |
30 | | - |
31 | 30 | ```bash |
| 31 | +# Start local dev server |
32 | 32 | pnpm dev |
33 | 33 | ``` |
34 | 34 |
|
35 | | -## Raise an Issue |
| 35 | +## Contributing |
| 36 | + |
| 37 | +We welcome contributions! Here's how to help: |
| 38 | + |
| 39 | +### Report Issues |
36 | 40 |
|
37 | | -Is something missing? |
38 | | -Is something confusing? |
39 | | -Is something wrong? |
| 41 | +Found a problem? Check if it's already been reported in our [issues](https://github.com/lycheeverse/lycheeverse.github.io/issues). If not, [create a new issue](https://github.com/lycheeverse/lycheeverse.github.io/issues/new/choose). |
40 | 42 |
|
41 | | -[See if your issue has already been reported](https://github.com/lycheeverse/lycheeverse.github.io/issues), and if not, [create a new one](https://github.com/lycheeverse/lycheeverse.github.io/issues/new/choose). |
| 43 | +### Submit Changes |
42 | 44 |
|
43 | | -## Make a Fix or Contribution |
| 45 | +1. Fork the repository |
| 46 | +2. Create a feature branch |
| 47 | +3. Make your changes (fix typos, broken links, etc.) |
| 48 | +4. Submit a pull request |
44 | 49 |
|
45 | | -Did you find a typo, a broken link, or another item with an obvious quick fix? |
| 50 | +## Project Structure |
46 | 51 |
|
47 | | -If you can see what the problem is, and you know how to fix it, then you can make a PR (pull request) with the change and contribute to the docs repo yourself. |
| 52 | +``` |
| 53 | +├── src/ |
| 54 | +│ ├── assets/ # Images and static files |
| 55 | +│ └── content/ # Documentation pages (Markdown/MDX) |
| 56 | +├── astro.config.mjs # Astro configuration |
| 57 | +└── package.json |
| 58 | +``` |
0 commit comments