diff --git a/docs/astro.config.mts b/docs/astro.config.mts index d0b2a453..4602050a 100644 --- a/docs/astro.config.mts +++ b/docs/astro.config.mts @@ -44,9 +44,6 @@ export default defineConfig({ }, }, integrations: [ - ui({ - noInjectResetCSS: true, - }), starlight({ title: 'StudioCMS UI', description: 'The UI library for StudioCMS, available for Astro for all to use.', @@ -99,9 +96,9 @@ export default defineConfig({ }, ], customCss: [ - '@studiocms/ui/css/global.css', './src/styles/sponsorcolors.css', './src/styles/starlight.css', + 'studiocms:ui/global-css', ], editLink: { baseUrl: 'https://github.com/withstudiocms/ui/tree/main/docs', @@ -228,5 +225,9 @@ export default defineConfig({ }, ], }), + ui({ + noInjectCSS: true, + noInjectResetCSS: true, + }), ], }); diff --git a/docs/src/content/docs/docs/index.mdx b/docs/src/content/docs/docs/index.mdx index 00fd99c5..f61ddbfa 100644 --- a/docs/src/content/docs/docs/index.mdx +++ b/docs/src/content/docs/docs/index.mdx @@ -8,20 +8,21 @@ integration: githubURL: "https://github.com/withstudiocms/ui/tree/main/packages/studiocms_ui" --- -import { PackageManagers } from 'starlight-package-managers' +import { PackageManagers } from "starlight-package-managers"; `@studiocms/ui` is the UI library that we use to build StudioCMS. The library is agnostic, meaning that you can use it -in your own Astro projects! +in your own Astro projects! To get started, add the integration to your project.
-Using `@studiocms/ui` with Astro 4 +Using `@studiocms/ui` with Astro 4 or 5 -StudioCMS UI can be used in Astro 5 without any additional configuration. As for Astro v4, `@studiocms/ui` requires version `v4.5.0` or higher, with the +StudioCMS UI can be used in Astro 5 without any additional configuration. As for Astro v4, `@studiocms/ui` requires version `v4.5.0` or higher, with the `experimental.directRenderScript` flag turned on. +
## Manual Installation @@ -33,13 +34,11 @@ Install the `@studiocms/ui` package with your preferred package manager. Import and use the `@studiocms/ui` integration in your Astro config. ```ts twoslash showLinenumbers title="astro.config.mjs" {2,6} -import { defineConfig } from 'astro/config'; -import ui from '@studiocms/ui'; +import { defineConfig } from "astro/config"; +import ui from "@studiocms/ui"; export default defineConfig({ - integrations: [ - ui() - ] + integrations: [ui()], }); ``` @@ -78,14 +77,11 @@ If you haven't already, add Astro's Tailwind integration to your project. Disable [Tailwind's preflight](https://tailwindcss.com/docs/preflight) styles with `applyBaseStyles: false`. ```ts showLinenumbers title="astro.config.mjs" "applyBaseStyles: false" -import { defineConfig } from 'astro/config'; -import ui from '@studiocms/ui'; +import { defineConfig } from "astro/config"; +import ui from "@studiocms/ui"; export default defineConfig({ - integrations: [ - ui(), - tailwind({ applyBaseStyles: false }) - ] + integrations: [ui(), tailwind({ applyBaseStyles: false })], }); ```