The docsframe.json
file holds configuration for your project.
Note: The docsframe.json
file is automatically created when you run the init
command.
See the Getting Started section for more information.
docsConfig
The docsConfig
section is used to configure all your documentation pages.
{
"docsConfig": {
"categories": [
{
"title": "Getting Started",
"items": [
{
"title": "Introduction",
"href": "/docs"
},
{
"title": "Getting Started",
"href": "/docs/getting-started"
},
{
"title": "docsframe.json",
"href": "/docs/docsframe-json"
},
{
"title": "MDX",
"href": "/docs/mdx-syntax"
}
]
},
{
"title": "Components",
"items": [
{
"title": "shadcn/ui",
"href": "/docs/components/shadcn"
},
{
"title": "Callout",
"href": "/docs/components/callout"
},
{
"title": "Tabs",
"href": "/docs/components/tabs"
},
{
"title": "Component Preview",
"href": "/docs/components/component-preview"
},
{
"title": "Code Collapsible",
"href": "/docs/components/code-collapsible"
}
]
}
]
}
}
contribution
The contribution
section is used to configure the contribution section in the sidebar. You can use this to link to your project's github repository.
{
"contribution": {
"owner": "",
"repo": ""
}
}
If you don't want to link to your project's repository, you can leave the contribution
section empty. If you use a different Git Hosting Service you can edit the contribute.tsx
in the components
folder.