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

Commit 09f3ad0

Browse files
committed
docs: update document settings
1 parent 3cfbc50 commit 09f3ad0

1 file changed

Lines changed: 14 additions & 10 deletions

File tree

src/docs/documentation/general/document-settings.mdx

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ menu: General
77

88
# Document settings
99

10-
Document settings can be something simple, but powerful. They should be defined in the top of the `.mdx`
11-
using yaml and can be used to change whatever you want by passing this config to your theme.
10+
Document settings provide a way to enrich documents with metadata used to generate your documentation site.
1211

13-
By default the document has **three** properties that can't be overriden:
12+
They are defined at the top of the `.mdx` file, use YAML and can be used to customize your pages by passing this data to your theme.
13+
14+
Every document has **three** main properties that can be overriden :
1415

1516
```markdown
1617
---
@@ -20,23 +21,26 @@ menu: Documents
2021
---
2122
```
2223

23-
- `name` Define the name of your component, the title of the page
24-
- `route *(optional)*` Define the route of your component.
24+
- `name` The name of your document, used as the title of the page
25+
- `route *(optional)*` The route or path to your document's generated page. e.g. /docs/my-component
2526

26-
>If you don't pass any here, we'll create a slug getting the filepath of your file as route.
27+
> If you don't pass any here, docz will create a slug using the filepath of your file as route. e.g. /src-components-my-components/
2728
28-
- `menu *(optional)*` Group documents into a single menu by changing this prop.
29+
- `menu *(optional)*` The menu within which your document is contained. It allows you to group documents into a single menu by changing this prop.
2930

3031
## Custom properties
3132

32-
The built in properties are for docz but docz is exstensible and you can create your own themes where you could have different needs and need different properties. Custom properties can be set in the document settings and they will automatically be parsed.
33+
The built in properties are for docz but docz is extensible and you can create your own themes which could need different properties.
34+
35+
Custom properties can be set in the document settings and they will automatically be parsed.
36+
37+
For example you could define a property called `fullpage` to define whether your document is a page with `100%` width or not:
3338

34-
For example you can define a property called `fullpage` to define whether your document is a page with `100%` width or not:
3539
```
3640
---
3741
name: My Document
3842
fullpage: true
3943
---
4044
```
4145

42-
When you later on are creating a theme these settings are passed to your theme components which you can read more about under [**Creating your themes: Using documents settings**](/docz/creating-your-themes#using-documents-settings)
46+
You could then use this property when overriding or creating a theme as shown in [**Creating your themes: Using documents settings**](/docz/creating-your-themes#using-documents-settings)

0 commit comments

Comments
 (0)