Document Configuration

In addition to the default MarkDown configuration of dumi, some additional fields have been added to meet more customization needs.

apiHeader

Example

Field Table

Field Name	Description	Default Value	Example
pkg	Imported component library	`package.name`	antd
defaultImport	Whether to enable defaultImport	`false`	-
docUrl	The markdown address of this document	-	https://github.com/xxx/xxx
sourceUrl	Points to the source code of this method	-	https://path/to/soure.tsx

The token configuration field is used to control the content size display in the document using tokens.

The supported token list is as follows:

Property Name	Type	Default Value	Description
footerHeight	`number`	`300`	Website footer height
sidebarWidth	`number`	`240`	Sidebar width
tocWidth	`number`	`176`	Directory width
contentMaxWidth	`number`	`1152`	Maximum content width

‌
‌
‌
‌

In addition to the default MarkDown configuration of dumi, some additional fields have been added to meet more customization needs.

Example

Field Table

Field Name	Description	Default Value	Example
pkg	Imported component library	`package.name`	antd
defaultImport	Whether to enable defaultImport	`false`	-
docUrl	The markdown address of this document	-	https://github.com/xxx/xxx
sourceUrl	Points to the source code of this method	-	https://path/to/soure.tsx

The token configuration field is used to control the content size display in the document using tokens.

The supported token list is as follows:

Property Name	Type	Default Value	Description
footerHeight	`number`	`300`	Website footer height
sidebarWidth	`number`	`240`	Sidebar width
tocWidth	`number`	`176`	Directory width
contentMaxWidth	`number`	`1152`	Maximum content width