|
1 | 1 | # VitePress Carbon
|
2 | 2 |
|
3 |
| -VitePress Carbon is a sleek and minimalistic theme for VitePress, inspired by GitHub's monochromatic design ethos. With its clean and elegant style, VitePress Carbon offers a seamless documentation experience, perfect for projects seeking simplicity and sophistication. |
| 3 | +VitePress Carbon is a sleek and minimalistic theme for VitePress, inspired by GitHub's monochromatic design ethos. With |
| 4 | +its clean and elegant style, VitePress Carbon offers a seamless documentation experience, perfect for projects seeking |
| 5 | +simplicity and sophistication. |
4 | 6 |
|
5 | 7 | ## Installation
|
6 | 8 |
|
7 |
| -To create a project with VitePress Carbon theme, use this template: |
| 9 | +To create a project with VitePress Carbon theme, you have three options: |
8 | 10 |
|
9 |
| -[VitePress Carbon Template](https://github.com/brenoepics/carbon-starter) |
| 11 | +1. Create a new project using the |
| 12 | + template: [click here](https://github.com/new?template_name=carbon-starter&template_owner=brenoepics). |
10 | 13 |
|
11 |
| -or add to an existing VitePress project: |
12 |
| -[Get Started](/guide/getting-started) |
| 14 | +2. Use the `vpcar` CLI tool to initialize a new VitePress Carbon project: |
| 15 | + ::: code-group |
| 16 | + |
| 17 | + ```sh [npm] |
| 18 | + npx vpcar init my-project |
| 19 | + ``` |
| 20 | + |
| 21 | + ```sh [pnpm] |
| 22 | + pnpm dlx vpcar init my-project |
| 23 | + ``` |
| 24 | + |
| 25 | + ```sh [yarn] |
| 26 | + yarn dlx vpcar init my-project |
| 27 | + ``` |
| 28 | + |
| 29 | + ```sh [bun] |
| 30 | + bun x vpcar init my-project |
| 31 | + ``` |
| 32 | + ::: |
| 33 | + |
| 34 | +3. Add VitePress Carbon to an existing VitePress project: Follow the [Getting Started guide](./getting-started). |
13 | 35 |
|
14 | 36 | ## Contribution Guidelines
|
15 | 37 |
|
16 |
| -If you encounter any issues or have suggestions for improvements, feel free to [open an issue](https://github.com/brenoepics/vitepress-carbon/issues) or [submit a pull request](https://github.com/brenoepics/vitepress-carbon/pulls). |
| 38 | +If you encounter any issues or have suggestions for improvements, feel free |
| 39 | +to [open an issue](https://github.com/brenoepics/vitepress-carbon/issues) |
| 40 | +or [submit a pull request](https://github.com/brenoepics/vitepress-carbon/pulls). |
17 | 41 | Your contributions and ⭐ are greatly appreciated!
|
18 |
| - |
|
0 commit comments