Skip to content

Commit

Permalink
docs(installer): #32 add automatic installation to quick start
Browse files Browse the repository at this point in the history
  • Loading branch information
sdorra committed Nov 13, 2024
1 parent 32678fd commit 4af5976
Showing 1 changed file with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,38 @@ Content Collections transforms your content into type-safe data collections, pro

### Installation

Content Collection supports most of the major web frameworks. Choose the one you are using to get started.
Content Collection supports most major web frameworks. You can install it [automatically](#automatic-installation-experimental) (currently experimental) or [manually](#manual-installation).

#### Automatic Installation (experimental)

<Callout type="warn">
Automatic installation is experimental and may not work for every project.
Please ensure you have committed your latest changes before running the installation.

If you encounter any issues, create a [ticket](https://github.com/sdorra/content-collections/issues) and use the manual installation.
</Callout>

Content collections can be installed automatically using the `content-collections` package.
The automatic installation currently supports the following frameworks:

- Next.js
- Remix
- Qwik
- SvelteKit
- SolidStart
- Vite

To install Content Collections automatically, run the following command in your project's directory:

```bash
npx content-collections install
```

The setup will guide you through the installation process and execute the necessary steps to configure Content Collections for your project.

#### Manual Installation

Choose the one you are using to get started.

<QuickStartList />

Expand Down

0 comments on commit 4af5976

Please sign in to comment.