Skip to content
This repository was archived by the owner on Jan 23, 2024. It is now read-only.

Commit d74e70d

Browse files
docs(gatsby-guide): update usage and include starter (#1598)
1 parent 50833a4 commit d74e70d

File tree

2 files changed

+31
-11
lines changed

2 files changed

+31
-11
lines changed

configs/search-meta.json

+11
Original file line numberDiff line numberDiff line change
@@ -56730,6 +56730,17 @@
5673056730
"url": "/getting-started/gatsby-guide#installation",
5673156731
"hierarchy": { "lvl1": "Gatsby", "lvl2": "Installation", "lvl3": null }
5673256732
},
56733+
{
56734+
"content": "Gatsby Starter",
56735+
"id": "//getting-started/gatsby-guide",
56736+
"type": "lvl3",
56737+
"url": "/getting-started/gatsby-guide#gatsby-starter",
56738+
"hierarchy": {
56739+
"lvl1": "Gatsby",
56740+
"lvl2": "Installation",
56741+
"lvl3": "Gatsby Starter"
56742+
}
56743+
},
5673356744
{
5673456745
"content": "Usage",
5673556746
"id": "//getting-started/gatsby-guide",

content/getting-started/gatsby-guide.mdx

+20-11
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,22 @@ can be done with the following command:
2323
}}
2424
/>
2525

26+
### Gatsby Starter
27+
28+
Alternatively, you can run a Gatsby Starter to have everything you need already
29+
set up
30+
31+
```bash
32+
gatsby new {your-project-name} https://github.com/chakra-ui/gatsby-starter-chakra-ui-ts
33+
```
34+
35+
This includes
36+
37+
- TypeScript
38+
- Chakra UI and needed dependencies
39+
- Chakra Gatsby Plugin
40+
- Basic Gatsby Boilerplate and Config
41+
2642
## Usage
2743

2844
After installation, you'll need to add `@chakra-ui/gatsby-plugin` to the
@@ -42,24 +58,17 @@ module.exports = {
4258
*/
4359
resetCSS: true,
4460
/**
45-
* @property {boolean} [isUsingColorMode=true]
46-
* if false, this plugin will not use <ColorModeProvider />
47-
*/
48-
isUsingColorMode: true,
49-
/**
50-
* @property {boolean} [isBaseProvider=false]
51-
* if true, will render `<ChakraBaseProvider>`
61+
* @property {number} [portalZIndex=undefined]
62+
* The z-index to apply to all portal nodes. This is useful
63+
* if your app uses a lot z-index to position elements.
5264
*/
53-
isBaseProvider: false,
65+
portalZIndex: undefined,
5466
},
5567
},
5668
],
5769
}
5870
```
5971

60-
> For info on the `isBaseProvider` option's usage, see
61-
> [Getting Started - ChakraBaseProvider](/getting-started#chakrabaseprovider)
62-
6372
To use a custom theme, you can
6473
[shadow](https://www.gatsbyjs.com/docs/how-to/plugins-and-themes/shadowing/)
6574
this plugin’s `theme.js` file with your own theme:

0 commit comments

Comments
 (0)