Skip to content

Commit 5ed7638

Browse files
committed
docs: improve how to get started
1 parent 59d6986 commit 5ed7638

File tree

3 files changed

+34
-10
lines changed

3 files changed

+34
-10
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Check out the demo on [GitHub Pages](https://carbon.breno.tech) to see VitePress
1616

1717
To create a GitHub project with VitePress Carbon
1818
theme, [click here](https://github.com/new?template_name=carbon-starter&template_owner=brenoepics).
19+
1920
Alternatively, you can use the [`vpcar`](https://github.com/brenoepics/vitepress-carbon/tree/main/packages/cli) CLI tool
2021
to initialize a new VitePress Carbon project:
2122

packages/demo/src/guide/introduction.md

+30-7
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,41 @@
11
# VitePress Carbon
22

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.
46

57
## Installation
68

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:
810

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).
1013

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).
1335

1436
## Contribution Guidelines
1537

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).
1741
Your contributions and ⭐ are greatly appreciated!
18-

packages/demo/src/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ hero:
1010
alt: VitePress Carbon
1111
actions:
1212
- theme: brand
13-
text: Get Started
13+
text: Introduction
1414
link: /guide/introduction
1515
- theme: alt
1616
text: View on GitHub
@@ -24,11 +24,11 @@ features:
2424
title: Responsive Design
2525
details: Ensure a consistent experience across devices.
2626
linkText: Explore
27-
link: https://github.com/brenoepics
27+
link: https://github.com/brenoepics/vitepress-carbon
2828
- icon: 🧩
2929
title: Seamless Integration
3030
details: Integrate seamlessly with your VitePress projects.
31-
link: https://github.com/brenoepics
31+
link: https://github.com/brenoepics/vitepress-carbon
3232
- icon: 🎨
3333
title: Customizable Theming
3434
details: Tailor the theme to suit your project's needs.

0 commit comments

Comments
 (0)