From 4af59768fced0b0e863297a4ff1abe264de7d080 Mon Sep 17 00:00:00 2001 From: Sebastian Sdorra Date: Wed, 13 Nov 2024 20:10:50 +0100 Subject: [PATCH] docs(installer): #32 add automatic installation to quick start --- docs/index.mdx | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/docs/index.mdx b/docs/index.mdx index 9d30062d..950d214e 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -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) + + +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. + + +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.