Skip to content

Commit 9df8ac2

Browse files
committed
fix: Make sure docs styles work as intended, add note about Astro v5
alongside v4
1 parent 8b541b1 commit 9df8ac2

2 files changed

Lines changed: 16 additions & 19 deletions

File tree

docs/astro.config.mts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,6 @@ export default defineConfig({
4444
},
4545
},
4646
integrations: [
47-
ui({
48-
noInjectResetCSS: true,
49-
}),
5047
starlight({
5148
title: 'StudioCMS UI',
5249
description: 'The UI library for StudioCMS, available for Astro for all to use.',
@@ -99,9 +96,9 @@ export default defineConfig({
9996
},
10097
],
10198
customCss: [
102-
'@studiocms/ui/css/global.css',
10399
'./src/styles/sponsorcolors.css',
104100
'./src/styles/starlight.css',
101+
'studiocms:ui/global-css',
105102
],
106103
editLink: {
107104
baseUrl: 'https://github.com/withstudiocms/ui/tree/main/docs',
@@ -228,5 +225,9 @@ export default defineConfig({
228225
},
229226
],
230227
}),
228+
ui({
229+
noInjectCSS: true,
230+
noInjectResetCSS: true,
231+
}),
231232
],
232233
});

docs/src/content/docs/docs/index.mdx

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,21 @@ integration:
88
githubURL: "https://github.com/withstudiocms/ui/tree/main/packages/studiocms_ui"
99
---
1010

11-
import { PackageManagers } from 'starlight-package-managers'
11+
import { PackageManagers } from "starlight-package-managers";
1212

1313
`@studiocms/ui` is the UI library that we use to build StudioCMS. The library is agnostic, meaning that you can use it
14-
in your own Astro projects!
14+
in your own Astro projects!
1515

1616
To get started, add the integration to your project.
1717

1818
<PackageManagers type="exec" pkg="astro add @studiocms/ui" />
1919

2020
<details>
21-
<summary>Using `@studiocms/ui` with Astro 4</summary>
21+
<summary>Using `@studiocms/ui` with Astro 4 or 5</summary>
2222

23-
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
23+
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
2424
`experimental.directRenderScript` flag turned on.
25+
2526
</details>
2627

2728
## Manual Installation
@@ -33,13 +34,11 @@ Install the `@studiocms/ui` package with your preferred package manager.
3334
Import and use the `@studiocms/ui` integration in your Astro config.
3435

3536
```ts twoslash showLinenumbers title="astro.config.mjs" {2,6}
36-
import { defineConfig } from 'astro/config';
37-
import ui from '@studiocms/ui';
37+
import { defineConfig } from "astro/config";
38+
import ui from "@studiocms/ui";
3839

3940
export default defineConfig({
40-
integrations: [
41-
ui()
42-
]
41+
integrations: [ui()],
4342
});
4443
```
4544

@@ -78,14 +77,11 @@ If you haven't already, add Astro's Tailwind integration to your project.
7877
Disable [Tailwind's preflight](https://tailwindcss.com/docs/preflight) styles with `applyBaseStyles: false`.
7978

8079
```ts showLinenumbers title="astro.config.mjs" "applyBaseStyles: false"
81-
import { defineConfig } from 'astro/config';
82-
import ui from '@studiocms/ui';
80+
import { defineConfig } from "astro/config";
81+
import ui from "@studiocms/ui";
8382

8483
export default defineConfig({
85-
integrations: [
86-
ui(),
87-
tailwind({ applyBaseStyles: false })
88-
]
84+
integrations: [ui(), tailwind({ applyBaseStyles: false })],
8985
});
9086
```
9187

0 commit comments

Comments
 (0)