Skip to content

Commit 0eb65f4

Browse files
authored
docs: remove export const components (skeletonlabs#3854)
1 parent 6ca97d8 commit 0eb65f4

File tree

133 files changed

+952
-1196
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

133 files changed

+952
-1196
lines changed

.github/instructions/sites/skeleton-dev.instructions.md

Lines changed: 14 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -82,35 +82,23 @@ stability: 'stable' # Optional: 'alpha', 'beta', or 'stable' (default)
8282

8383
```mdx
8484
---
85-
layout: '@layouts/LayoutDoc.astro'
85+
layout: '@/layouts/LayoutDoc.astro'
8686
---
8787
```
8888

89-
### Required Exports
90-
91-
Must include this line at the top after frontmatter:
92-
93-
```mdx
94-
export const components = componentSet;
95-
96-
;
97-
```
98-
99-
This enables custom MDX component overrides (styled headings, links, tables, etc.).
100-
10189
### Import Pattern
10290

10391
Import examples and their raw source code in **alphabetical order by feature name**:
10492

10593
```mdx
106-
import Default from '@examples/components/avatar/react/default.tsx';
107-
import DefaultRaw from '@examples/components/avatar/react/default.tsx?raw';
94+
import Default from '@/examples/components/avatar/react/default.tsx';
95+
import DefaultRaw from '@/examples/components/avatar/react/default.tsx?raw';
10896

109-
import Fallback from '@examples/components/avatar/react/fallback.tsx';
110-
import FallbackRaw from '@examples/components/avatar/react/fallback.tsx?raw';
97+
import Fallback from '@/examples/components/avatar/react/fallback.tsx';
98+
import FallbackRaw from '@/examples/components/avatar/react/fallback.tsx?raw';
11199

112-
import Filter from '@examples/components/avatar/react/filter.tsx';
113-
import FilterRaw from '@examples/components/avatar/react/filter.tsx?raw';
100+
import Filter from '@/examples/components/avatar/react/filter.tsx';
101+
import FilterRaw from '@/examples/components/avatar/react/filter.tsx?raw';
114102

115103
;
116104
```
@@ -354,13 +342,11 @@ The generation script is in `scripts/generate-type-documentation/`.
354342

355343
```mdx
356344
---
357-
layout: '@layouts/LayoutDoc.astro'
345+
layout: '@/layouts/LayoutDoc.astro'
358346
---
359347

360-
export const components = componentSet;
361-
362-
import Default from '@examples/components/example/react/default.tsx';
363-
import DefaultRaw from '@examples/components/example/react/default.tsx?raw';
348+
import Default from '@/examples/components/example/react/default.tsx';
349+
import DefaultRaw from '@/examples/components/example/react/default.tsx?raw';
364350

365351
<Preview client:load>
366352
<Fragment slot="preview">
@@ -379,11 +365,11 @@ import DefaultRaw from '@examples/components/example/react/default.tsx?raw';
379365
### Multiple Examples Pattern
380366

381367
```mdx
382-
import Default from '@examples/components/example/react/default.tsx';
383-
import DefaultRaw from '@examples/components/example/react/default.tsx?raw';
368+
import Default from '@/examples/components/example/react/default.tsx';
369+
import DefaultRaw from '@/examples/components/example/react/default.tsx?raw';
384370

385-
import Advanced from '@examples/components/example/react/advanced.tsx';
386-
import AdvancedRaw from '@examples/components/example/react/advanced.tsx?raw';
371+
import Advanced from '@/examples/components/example/react/advanced.tsx';
372+
import AdvancedRaw from '@/examples/components/example/react/advanced.tsx?raw';
387373

388374
<Preview client:load>
389375
<Fragment slot="preview">
@@ -466,7 +452,6 @@ Before submitting documentation:
466452

467453
## Common Mistakes to Avoid
468454

469-
- Forgetting `export const components = componentSet;` at the top
470455
- Incorrect import paths (use `@examples/` alias)
471456
- Missing `.tsx` or `.svelte` extensions in imports
472457
- Not using `?raw` suffix for source code imports

sites/skeleton.dev/astro.config.js

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -43,21 +43,19 @@ export default defineConfig({
4343
// https://github.com/delucis/astro-auto-import/tree/main/packages/astro-auto-import
4444
AutoImport({
4545
imports: [
46-
// import ApiTable from '@components/docs/ApiTable.astro';
47-
'@components/docs/ApiTable.astro',
48-
// import Anatomy from '@components/docs/Anatomy.astro';
49-
'@components/docs/Anatomy.astro',
46+
// import ApiTable from '@/components/docs/ApiTable.astro';
47+
'@/components/docs/ApiTable.astro',
48+
// import Anatomy from '@/components/docs/Anatomy.astro';
49+
'@/components/docs/Anatomy.astro',
5050
{
51-
// import componentSet from "@components/mdx/index";
52-
'@components/mdx/index': [['default', 'componentSet']],
5351
// import { Icon } from 'astro-icon/components';
5452
'astro-icon/components': ['Icon'],
5553
// import { Code } from 'astro-expressive-code/components';
5654
'astro-expressive-code/components': ['Code'],
57-
// import { Preview } from '@components/docs/Preview.tsx';
58-
'@components/docs/Preview.tsx': ['Preview'],
59-
// import { FrameworkTabs } from '@components/docs/FrameworkTabs';
60-
'@components/docs/FrameworkTabs.tsx': ['FrameworkTabs'],
55+
// import { Preview } from '@/components/docs/Preview.tsx';
56+
'@/components/docs/Preview.tsx': ['Preview'],
57+
// import { FrameworkTabs } from '@/components/docs/FrameworkTabs';
58+
'@/components/docs/FrameworkTabs.tsx': ['FrameworkTabs'],
6159
},
6260
],
6361
}),

sites/skeleton.dev/scripts/generate-type-documentation/index.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
// oxlint-disable-next-line no-unused-vars
2-
import { MONOREPO_DIRECTORY, PACKAGE_DIRECTORY, SITE_DIRECTORY } from './constants';
1+
import { PACKAGE_DIRECTORY, SITE_DIRECTORY } from './constants';
32
import { Parser } from './parser';
43
import { kebabToCamel, kebabToPascal } from './string-utils';
54
import { mkdir, readFile, rm, writeFile } from 'node:fs/promises';

sites/skeleton.dev/src/components/docs/Header.astro

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
// Stores
33
// Components
4-
import Drawer from '@components/docs/Drawer.astro';
5-
import LightSwitch from '@components/docs/LightSwitch.svelte';
6-
import Navigation from '@components/docs/Navigation.astro';
4+
import Drawer from '@/components/docs/Drawer.astro';
5+
import LightSwitch from '@/components/docs/LightSwitch.svelte';
6+
import Navigation from '@/components/docs/Navigation.astro';
77
// Icons
88
import { Icon } from 'astro-icon/components';
99
import { socialLinks } from 'src/stores/social-links';

0 commit comments

Comments
 (0)