Skip to content

Commit 31443b3

Browse files
authored
Merge pull request #820 from dburles/docs-core-install
Update documentation for core installation
2 parents debd149 + 32f652c commit 31443b3

File tree

8 files changed

+34
-4
lines changed

8 files changed

+34
-4
lines changed

packages/components/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33

44
Primitive layout, typographic, and other components for use with Theme UI.
55

6+
**Note:** *This package is included in the main `theme-ui` package and a separate installation is not required.*
7+
68
```sh
79
npm i @theme-ui/components
810
```

packages/core/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@ Core Emotion and JSX implementation for Theme UI
55

66
https://theme-ui.com
77

8-
**Note:** *This package is included in the main `theme-ui` package, and generally should not be used on its own.*
9-
108
```sh
119
npm i @theme-ui/core
1210
```
1311

12+
## Usage
13+
14+
This package is already included in the main `theme-ui` package. However, for a minimal installation, it's possible to install this standalone and then subsequently install only the packages you require.
15+
1416
## API
1517

1618
- `jsx`
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "@theme-ui/components"
3+
---
4+
5+
import Readme from '@theme-ui/components/README.md'
6+
7+
<Readme />
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "@theme-ui/core"
3+
---
4+
5+
import Readme from '@theme-ui/core/README.md'
6+
7+
<Readme />

packages/docs/src/pages/packages/index.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ In addition to the core library, Theme UI includes several optional packages.
1111

1212
<Cards width={320}>
1313

14-
- [@theme-ui/components](/components)
14+
- [@theme-ui/core](/packages/core)
15+
- [@theme-ui/components](/packages/components)
16+
- [@theme-ui/mdx](/packages/mdx)
1517
- [@theme-ui/presets](/packages/presets)
1618
- [@theme-ui/prism](/packages/prism)
1719
- [@theme-ui/color](/packages/color)
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "@theme-ui/mdx"
3+
---
4+
5+
import Readme from '@theme-ui/mdx/README.md'
6+
7+
<Readme />

packages/docs/src/sidebar.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@
4848
- [IconButton](/components/icon-button)
4949
- [MenuButton](/components/menu-button)
5050
- [Packages](/packages)
51+
- [@theme-ui/core](/packages/core)
52+
- [@theme-ui/components](/packages/components)
53+
- [@theme-ui/mdx](/packages/mdx)
5154
- [@theme-ui/presets](/packages/presets)
5255
- [@theme-ui/prism](/packages/prism)
5356
- [@theme-ui/color](/packages/color)

packages/mdx/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ MDX component context for Theme UI
55

66
https://theme-ui.com
77

8-
**Note:** *This package is included in the main `theme-ui` package, and generally should not be used on its own.*
8+
**Note:** *This package is included in the main `theme-ui` package and a separate installation is not required.*
99

1010
```sh
1111
npm i @theme-ui/mdx

0 commit comments

Comments
 (0)