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/general/document-settings.mdx
+14-10Lines changed: 14 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,10 +7,11 @@ menu: General
7
7
8
8
# Document settings
9
9
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.
12
11
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 :
14
15
15
16
```markdown
16
17
---
@@ -20,23 +21,26 @@ menu: Documents
20
21
---
21
22
```
22
23
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
25
26
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/
27
28
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.
29
30
30
31
## Custom properties
31
32
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:
33
38
34
-
For example you can define a property called `fullpage` to define whether your document is a page with `100%` width or not:
35
39
```
36
40
---
37
41
name: My Document
38
42
fullpage: true
39
43
---
40
44
```
41
45
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