@roadlittledawn/docs-design-system-react 0.9.1 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -3
- package/USAGE.md +1070 -0
- package/dist/components/Breadcrumb.d.ts +41 -0
- package/dist/components/Breadcrumb.js +49 -0
- package/dist/components/Breadcrumb.stories.d.ts +40 -0
- package/dist/components/Breadcrumb.stories.js +216 -0
- package/dist/components/Button.d.ts +1 -2
- package/dist/components/Callout.d.ts +1 -2
- package/dist/components/Card.d.ts +1 -2
- package/dist/components/CardGrid.d.ts +1 -2
- package/dist/components/CodeBlock.d.ts +1 -2
- package/dist/components/CollapserGroup.d.ts +1 -0
- package/dist/components/Heading.d.ts +1 -2
- package/dist/components/Icon.d.ts +52 -0
- package/dist/components/Icon.js +49 -0
- package/dist/components/Icon.stories.d.ts +31 -0
- package/dist/components/Icon.stories.js +141 -0
- package/dist/components/Link.d.ts +1 -2
- package/dist/components/List.d.ts +1 -2
- package/dist/components/Tabs.d.ts +4 -5
- package/dist/components/Typography.d.ts +1 -2
- package/dist/index.d.ts +2 -0
- package/dist/index.js +2 -0
- package/dist/styles.css +147 -0
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
# @roadlittledawn/docs-design-system-react
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/@roadlittledawn/docs-design-system-react)
|
|
4
|
-
[](https://github.com/roadlittledawn/docs-design-system)
|
|
3
|
+
[](https://www.npmjs.com/package/@roadlittledawn/docs-design-system-react) [](https://github.com/roadlittledawn/docs-design-system)
|
|
5
4
|
|
|
6
5
|
React components for documentation content and MDX-driven sites.
|
|
7
6
|
|
|
@@ -37,7 +36,7 @@ Full component documentation with live examples, usage guidelines, and API docum
|
|
|
37
36
|
|
|
38
37
|
## Next.js / React Server Components
|
|
39
38
|
|
|
40
|
-
Interactive components (`Collapser`, `CollapserGroup`, `CodeBlock`, `Tabs`, `Popover
|
|
39
|
+
Interactive components (e.g., `Collapser`, `CollapserGroup`, `CodeBlock`, `Tabs`, `Popover`, etc) are pre-marked with `'use client'`, so they work in Next.js App Router without any extra setup. Stateless components (e.g., `Button`, `Callout`, `Card`, `CardGrid`, `Heading`, `Link`, `List`, etc) have no directive and are fully usable as Server Components.
|
|
41
40
|
|
|
42
41
|
## Dark Mode
|
|
43
42
|
|
|
@@ -100,6 +99,29 @@ const isPressed = useKeyPress("Escape");
|
|
|
100
99
|
|
|
101
100
|
Full hook documentation is available in [Storybook](https://docs-design-system-storybook.netlify.app).
|
|
102
101
|
|
|
102
|
+
## AI / LLM Integration
|
|
103
|
+
|
|
104
|
+
This package ships with AI-friendly docs so coding assistants can understand the component API without browser access.
|
|
105
|
+
|
|
106
|
+
### `USAGE.md` (included in npm package)
|
|
107
|
+
|
|
108
|
+
A complete component reference with props tables and usage examples. Point your AI tool at it with one line:
|
|
109
|
+
|
|
110
|
+
```
|
|
111
|
+
# CLAUDE.md or equivalent
|
|
112
|
+
Component API docs: node_modules/@roadlittledawn/docs-design-system-react/USAGE.md
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Or reference the raw file on GitHub in any AI context file.
|
|
116
|
+
|
|
117
|
+
### `/llms.txt` (Storybook site)
|
|
118
|
+
|
|
119
|
+
The Storybook site serves a machine-readable component reference at [`/llms.txt`](https://docs-design-system-storybook.netlify.app/llms.txt) per the [llmstxt.org](https://llmstxt.org/) convention. Agents can fetch the full API reference from a single URL.
|
|
120
|
+
|
|
121
|
+
### TypeScript types with JSDoc
|
|
122
|
+
|
|
123
|
+
All prop interfaces are exported and annotated with JSDoc so AI tools reading `.d.ts` files from `node_modules` get full prop descriptions and types.
|
|
124
|
+
|
|
103
125
|
## Development
|
|
104
126
|
|
|
105
127
|
```bash
|