Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(guide): add an explanation for the installation guide #2769

Merged
merged 3 commits into from
Apr 25, 2024
Merged

docs(guide): add an explanation for the installation guide #2769

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d7e1f45
docs(guide): add an explanation for the installation guide
Nozomi-Hijikata Apr 18, 2024
1f38992
docs(guide): add an explanation for the cli guide
Nozomi-Hijikata Apr 19, 2024
04d16a7
docs(guide): add support for cli output
Nozomi-Hijikata Apr 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion apps/docs/content/docs/guide/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Commands:
Initialize a new NextUI project using the `init` command. This sets up your project with the necessary configurations.

```codeBlock bash
nextui init [my-nextui-app-name]
nextui init my-nextui-app
```

<Spacer y={4} />
Expand All @@ -90,6 +90,16 @@ You will be prompted to configure your project:
A Next.js 13 with pages directory template pre-configured with NextUI (v2) and Tailwind CSS.
```

Install the dependencies to start the local server:
```codeBlock bash
cd my-nextui-app && npm install
```

Start the local server:
```codeBlock bash
npm run dev
```

## add

Add components to your NextUI project with the add command. This command manages component dependencies and updates your project configurations.
Expand Down
12 changes: 11 additions & 1 deletion apps/docs/content/docs/guide/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,17 @@ You will be prompted to configure your project:
A Next.js 13 with pages directory template pre-configured with NextUI (v2) and Tailwind CSS.
```

Once your NextUI project is initialized, you can add individual components using the CLI. For example, to add a button component:
Install the dependencies to start the local server:
```codeBlock bash
cd my-nextui-app && npm install
```

Start the local server:
```codeBlock bash
npm run dev
```

Once your NextUI project is ready to develop, you can add individual components using the CLI. For example, to add a button component:

```codeBlock bash
nextui add button
Expand Down