\nAdd Netlify CMS’s admin dashboard\nto any Astro project\n
\n\n## Installation\n\n```bash\nnpm i astro-netlify-cms\n```\n\n## What is this?\n\nThis is an integration for the [Astro](https://astro.build/) site builder,\nwhich adds support for [Netlify CMS](https://www.netlifycms.org/), an\nopen-source, Git-based content management system.\n\nAdding the integration will:\n\n- Add the Netlify CMS dashboard at `/admin` (or another route if you prefer)\n- Inject Netlify’s [Identity Widget](https://github.com/netlify/netlify-identity-widget) across your site to support logging in to the admin app\n- Run a [local proxy server](https://www.netlifycms.org/docs/beta-features/#working-with-a-local-git-repository) in `dev` mode to allow local content updates via the CMS\n\nUsually each of these requires individual set up and configuration. Using this integration, you configure your CMS once in `astro.config.mjs`, sit back, and enjoy!\n\n> Looking for a quick way to get started? [Try out the Blog Starter with Netlify CMS →](https://github.com/delucis/astro-netlify-cms-starter)\n\n## Usage\n\n### Adding the integration\n\nTo add Netlify CMS to your project, import and use the integration in your\nAstro config file, adding it to the `integrations` array.\n\n```js\n// astro.config.mjs\n\nimport { defineConfig } from 'astro/config';\nimport NetlifyCMS from 'astro-netlify-cms';\n\nexport default defineConfig({\n integrations: [\n NetlifyCMS({\n config: {\n backend: {\n name: 'git-gateway',\n branch: 'main',\n },\n collections: [\n // Content collections\n ],\n },\n }),\n ],\n});\n```\n\n### Configuration options\n\nYou can pass an options object to the integration to configure how it behaves.\n\n#### `adminPath`\n\n**Type:** `string` \n**Default:** `'/admin'`\n\nDetermines the route where the Netlify CMS admin dashboard will be available on your site.\n\nFeeling nostalgic for WordPress? You could set this to `'/wp-admin'`!\n\n#### `config`\n\n**Type:** `CmsConfig`\n\nThis option is **required**. It allows you to configure Netlify CMS with the\nsame options you would use when using Netlify CMS’s `config.yml` file format.\n\nYou can see [a full list of configuration options in the Netlify CMS docs](https://www.netlifycms.org/docs/configuration-options/).\n\nAt a minimum, you _must_ set the `backend` and `collections` options:\n\n```js\nconfig: {\n // Use Netlify’s “Git Gateway” authentication and target our default branch\n backend: {\n name: 'git-gateway',\n branch: 'main',\n },\n collections: [\n // Define a blog post collection\n {\n name: 'posts',\n label: 'Blog Posts',\n folder: 'src/pages/posts',\n create: true,\n delete: true,\n fields: [\n { name: 'title', widget: 'string', label: 'Post Title' },\n { name: 'body', widget: 'markdown', label: 'Post Body' },\n ],\n },\n ],\n};\n```\n\n#### `previewStyles`\n\n**Type:** `Array\nAdd Netlify CMS’s admin dashboard\nto any Astro project\n
\n\n## Installation\n\n```bash\nnpm i astro-netlify-cms\n```\n\n## What is this?\n\nThis is an integration for the [Astro](https://astro.build/) site builder,\nwhich adds support for [Netlify CMS](https://www.netlifycms.org/), an\nopen-source, Git-based content management system.\n\nAdding the integration will:\n\n- Add the Netlify CMS dashboard at `/admin` (or another route if you prefer)\n- Inject Netlify’s [Identity Widget](https://github.com/netlify/netlify-identity-widget) across your site to support logging in to the admin app\n- Run a [local proxy server](https://www.netlifycms.org/docs/beta-features/#working-with-a-local-git-repository) in `dev` mode to allow local content updates via the CMS\n\nUsually each of these requires individual set up and configuration. Using this integration, you configure your CMS once in `astro.config.mjs`, sit back, and enjoy!\n\n> Looking for a quick way to get started? [Try out the Blog Starter with Netlify CMS →](https://github.com/delucis/astro-netlify-cms-starter)\n\n## Usage\n\n### Adding the integration\n\nTo add Netlify CMS to your project, import and use the integration in your\nAstro config file, adding it to the `integrations` array.\n\n```js\n// astro.config.mjs\n\nimport { defineConfig } from 'astro/config';\nimport NetlifyCMS from 'astro-netlify-cms';\n\nexport default defineConfig({\n integrations: [\n NetlifyCMS({\n config: {\n backend: {\n name: 'git-gateway',\n branch: 'main',\n },\n collections: [\n // Content collections\n ],\n },\n }),\n ],\n});\n```\n\n### Configuration options\n\nYou can pass an options object to the integration to configure how it behaves.\n\n#### `adminPath`\n\n**Type:** `string` \n**Default:** `'/admin'`\n\nDetermines the route where the Netlify CMS admin dashboard will be available on your site.\n\nFeeling nostalgic for WordPress? You could set this to `'/wp-admin'`!\n\n#### `config`\n\n**Type:** `CmsConfig`\n\nThis option is **required**. It allows you to configure Netlify CMS with the\nsame options you would use when using Netlify CMS’s `config.yml` file format.\n\nYou can see [a full list of configuration options in the Netlify CMS docs](https://www.netlifycms.org/docs/configuration-options/).\n\nAt a minimum, you _must_ set the `backend` and `collections` options:\n\n```js\nconfig: {\n // Use Netlify’s “Git Gateway” authentication and target our default branch\n backend: {\n name: 'git-gateway',\n branch: 'main',\n },\n collections: [\n // Define a blog post collection\n {\n name: 'posts',\n label: 'Blog Posts',\n folder: 'src/pages/posts',\n create: true,\n delete: true,\n fields: [\n { name: 'title', widget: 'string', label: 'Post Title' },\n { name: 'body', widget: 'markdown', label: 'Post Body' },\n ],\n },\n ],\n};\n```\n\n#### `previewStyles`\n\n**Type:** `Array