Skip to content

Commit 53e1f1b

Browse files
committed
📝 docs: configuration.mdx, mdx-components.tsx
1 parent c459868 commit 53e1f1b

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

docs/content/docs/configuration.mdx

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,3 +141,31 @@ This is a helper function providing type intellisense, you can just export an ob
141141
}
142142
}
143143
```
144+
145+
## Reference
146+
147+
<TypeTable
148+
type={{
149+
autoEmoji: {
150+
description:
151+
'Automatically add an emoji when the commit message does not contain one.',
152+
type: 'boolean',
153+
default: 'true',
154+
},
155+
autoScope: {
156+
description: `Automatically infer the scope from the package names`,
157+
type: 'boolean | "replaceToPackageName" | "defaultToPackageName"',
158+
default: 'true',
159+
},
160+
defaultType: {
161+
description: `If type is missing, fill the default type`,
162+
type: 'string',
163+
default: 'fix',
164+
},
165+
types: {
166+
description: `An object that defines commit types and emojis`,
167+
type: 'Type',
168+
default: 'fix',
169+
},
170+
}}
171+
/>

docs/mdx-components.tsx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { TypeTable } from "fumadocs-ui/components/type-table";
12
import defaultMdxComponents from "fumadocs-ui/mdx";
23
import * as icons from "lucide-react";
34
import type { MDXComponents } from "mdx/types";
@@ -7,5 +8,6 @@ export function getMDXComponents(components?: MDXComponents): MDXComponents {
78
...defaultMdxComponents,
89
...components,
910
...(icons as unknown as MDXComponents),
11+
TypeTable,
1012
};
1113
}

0 commit comments

Comments
 (0)