You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 16, 2026. It is now read-only.
Copy file name to clipboardExpand all lines: src/docs/documentation/references/project-configuration.mdx
+19-24Lines changed: 19 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ menu: References
9
9
10
10
The project configuration is used when you need to define some specific customizations on your project. Like use plugins, chose themes, set project title, and other things.
11
11
12
-
To customize your project configuration just create`doczrc.js` following this reference.
12
+
To customize your project configuration you can use`doczrc.js` following this reference.
13
13
14
14
## Env file
15
15
@@ -19,9 +19,9 @@ You can also create a `.env` file or use an existing `.env` file. You can then d
19
19
20
20
You can also pass customizations as arguments to the `docz dev` command: `docz dev --typescript --port=4838`
21
21
22
-
> ### Tips and tricks
22
+
<!--> ### Tips and tricks
23
23
>
24
-
> You can create a `doczrc.json` file too if you want, but we recommend that you use a `js` file because just with javascript you can set plugins in your configuration since plugins are functions!
24
+
> You can create a `doczrc.json` file too if you want, but we recommend that you use a `js` file because just with javascript you can set plugins in your configuration since plugins are functions! -->
25
25
26
26
## Basic config
27
27
@@ -34,7 +34,7 @@ The base URL of the site will be deployed at. You will need to set this if you p
34
34
35
35
> It should always start and end with a slash.
36
36
37
-
The base is automatically prepend to all the URLs that start with `/` in other options, so you only need to specify it once.
37
+
The base is automatically prepended to all URLs that start with `/` in other options, so you only need to specify it once.
38
38
39
39
### src
40
40
@@ -45,21 +45,23 @@ Define the source folder of **your components**. Only the files in this folder w
45
45
46
46
> ### Tips and tricks
47
47
>
48
-
> If you want to boost performance, you can limit by passing your source folder here!
48
+
> If you want to boost performance, you can limit the amount of files parsed by passing your source folder here!
To be able to use the `<Props />` component and parse properties of your components, we need to run a lot of processes that have some costs on the build process. If you need to disable this process to improve performance, you can just this property to `false`.
112
+
To be able to use the `<Props />` component and parse properties of your components, we need to run a lot of processes that have some costs on the build process. If you need to disable this process to improve performance, you can set this property to `false`.
111
113
112
114
### config
113
115
@@ -145,13 +147,6 @@ Then you can get assets from your folder:
145
147
146
148
Use this setting to debug your application and remove all progress bar from bundler.
147
149
148
-
### native
149
-
150
-
- Type: `Boolean`
151
-
- Default: `false`
152
-
153
-
Use this option to specify if you're in a native enrivonment or not.
154
-
155
150
### editBranch
156
151
157
152
- Type: `string`
@@ -180,22 +175,22 @@ Specify the port to use for the dev server.
180
175
181
176
> This property was removed in the v2
182
177
>
183
-
> Check more information about how to use it [here](https://www.docz.site/docs/migration-guide#theme-property-removed)
178
+
> Get more information about how to use it [here](https://www.docz.site/docs/migration-guide#theme-property-removed)
184
179
185
180
### wrapper
186
181
187
182
> This property was removed in the v2.
188
183
>
189
-
> Check more information about how to use it [here](https://www.docz.site/docs/migration-guide#wrapper-property-removed)
184
+
> Get more information about how to use it [here](https://www.docz.site/docs/migration-guide#wrapper-property-removed)
190
185
191
186
### themeConfig
192
187
193
188
- Type: `Object`
194
189
- Default: `{}`
195
190
196
-
This is the config that your theme will use to customize it. By default, each theme has your own `themeConfig` that you can modify, so this object may vary according to each theme.
191
+
This is the config that you can use to customize your theme. By default, each theme has its own `themeConfig` that you can modify, so this object may vary according to each theme.
197
192
198
-
You can see the theme config of default theme [here](https://github.com/pedronauck/docz/blob/master/core/docz-theme-default/src/config.ts)
193
+
You can see the theme config of default theme [here](https://github.com/doczjs/docz/blob/master/core/gatsby-theme-docz/src/theme/index.js)
199
194
200
195
## Build pipeline
201
196
@@ -239,18 +234,18 @@ Array of [rehype plugins](https://github.com/rehypejs/rehype/blob/master/doc/plu
239
234
240
235
### onCreateWebpackChain
241
236
242
-
> This property was removed in the v2. Use Gatsby hooks instead.
237
+
> This property was removed in v2. Use Gatsby hooks instead.
243
238
>
244
239
> More info about it [here](https://www.docz.site/docs/powered-by-gatsby)
245
240
246
241
### modifyBundlerConfig
247
242
248
-
> This property was removed in the v2. Use Gatsby hooks instead.
243
+
> This property was removed in v2. Use Gatsby hooks instead.
249
244
>
250
245
> More info about it [here](https://www.docz.site/docs/powered-by-gatsby)
251
246
252
247
### modifyBabelRc
253
248
254
-
> This property was removed in the v2. Use Gatsby hooks instead.
249
+
> This property was removed in v2. Use Gatsby hooks instead.
255
250
>
256
251
> More info about it [here](https://www.docz.site/docs/powered-by-gatsby)
0 commit comments