Skip to content
This repository was archived by the owner on Mar 16, 2026. It is now read-only.

Commit aa4e752

Browse files
committed
docs: update project-configuration
1 parent 7025a42 commit aa4e752

File tree

1 file changed

+19
-24
lines changed

1 file changed

+19
-24
lines changed

src/docs/documentation/references/project-configuration.mdx

Lines changed: 19 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ menu: References
99

1010
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.
1111

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.
1313

1414
## Env file
1515

@@ -19,9 +19,9 @@ You can also create a `.env` file or use an existing `.env` file. You can then d
1919

2020
You can also pass customizations as arguments to the `docz dev` command: `docz dev --typescript --port=4838`
2121

22-
> ### Tips and tricks
22+
<!-- > ### Tips and tricks
2323
>
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! -->
2525
2626
## Basic config
2727

@@ -34,7 +34,7 @@ The base URL of the site will be deployed at. You will need to set this if you p
3434

3535
> It should always start and end with a slash.
3636
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.
3838

3939
### src
4040

@@ -45,21 +45,23 @@ Define the source folder of **your components**. Only the files in this folder w
4545

4646
> ### Tips and tricks
4747
>
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!
4949
5050
### files
5151

52-
- Type: `string`
52+
- Type: `string` or `Array<string>`
5353
- Default: `process.env.DOCZ_FILES || '**/*.{md,markdown,mdx}'`
5454

5555
Glob pattern used to find your files.
56-
By default, Docz finds all files inside the source folder that has a `.mdx` extension.
56+
By default, Docz finds all files inside the source folder that have a `.mdx` extension.
57+
5758
[As of v0.10](https://github.com/pedronauck/docz/releases/tag/v0.10.0), you can customize it to resolve other filetypes:
5859

5960
```js
6061
// doczrc.js
6162
export default {
6263
files: '**/*.{md,markdown,mdx}'
64+
// or files: ['**/*.{md,markdown,mdx}']
6365
}
6466
```
6567

@@ -72,7 +74,7 @@ You can be more specific if you want and change this glob to find other rules.
7274
- Type: `string[]`
7375
- Default: `['readme.md', 'changelog.md', 'code_of_conduct.md', 'contributing.md', 'license.md'],`
7476

75-
Option used to ignore file to be parsed a doc.
77+
Option used to ignore files to be parsed by docz.
7678

7779
### dest
7880

@@ -86,7 +88,7 @@ Specify the output directory for `docz build`
8688
- Type: `string`
8789
- Default: `process.env.DOCZ_TITLE || name as defined in package.json`
8890

89-
The title for the site. This will be the prefix for all page titles and displayed in the sidebar in the default theme.
91+
The title for your site. This will be the prefix for all page titles and displayed in the sidebar in the default theme.
9092

9193
### description
9294

@@ -107,7 +109,7 @@ This option is used if you need to import Typescript components inside your `.md
107109
- Type: `boolean`
108110
- Default: `process.env.DOCZ_PROPS_PARSER || true`
109111

110-
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`.
111113

112114
### config
113115

@@ -145,13 +147,6 @@ Then you can get assets from your folder:
145147

146148
Use this setting to debug your application and remove all progress bar from bundler.
147149

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-
155150
### editBranch
156151

157152
- Type: `string`
@@ -180,22 +175,22 @@ Specify the port to use for the dev server.
180175

181176
> This property was removed in the v2
182177
>
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)
184179
185180
### wrapper
186181

187182
> This property was removed in the v2.
188183
>
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)
190185
191186
### themeConfig
192187

193188
- Type: `Object`
194189
- Default: `{}`
195190

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.
197192

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)
199194

200195
## Build pipeline
201196

@@ -239,18 +234,18 @@ Array of [rehype plugins](https://github.com/rehypejs/rehype/blob/master/doc/plu
239234

240235
### onCreateWebpackChain
241236

242-
> This property was removed in the v2. Use Gatsby hooks instead.
237+
> This property was removed in v2. Use Gatsby hooks instead.
243238
>
244239
> More info about it [here](https://www.docz.site/docs/powered-by-gatsby)
245240
246241
### modifyBundlerConfig
247242

248-
> This property was removed in the v2. Use Gatsby hooks instead.
243+
> This property was removed in v2. Use Gatsby hooks instead.
249244
>
250245
> More info about it [here](https://www.docz.site/docs/powered-by-gatsby)
251246
252247
### modifyBabelRc
253248

254-
> This property was removed in the v2. Use Gatsby hooks instead.
249+
> This property was removed in v2. Use Gatsby hooks instead.
255250
>
256251
> More info about it [here](https://www.docz.site/docs/powered-by-gatsby)

0 commit comments

Comments
 (0)