Typescript
Generate docs from Typescript definitions
Usage
UI Integration
It comes with the AutoTypeTable
component. Learn more about Auto Type Table.
Generate MDX Files
You may generate MDX files statically.
Create a model MDX file.
Run this script with node ./script.mjs
.
Generated MDX files assumes you are using the Tailwind CSS preset of Fumadocs UI.
If you want to customise generated output, use the templates
option.
Annotations
Hide
Hide a field by adding @internal
tsdoc tag.
Specify Type Name
You can specify the name of a type with the @remarks
tsdoc tag.
This will make the type of time
property to be shown as timestamp
.
Demo
Below is an example generated from Typescript definitions.
NavbarProps
enabled
boolean
No Description
component
ReactNode
No Description
githubUrl
string
GitHub url displayed on the navbar
title
ReactNode
No Description
url
string
Redirect url of title
- defaultValue: '/'
transparentMode
"always" | "top" | "none"
When to use transparent navbar
- defaultValue: none
children
ReactNode
No Description
Last updated on