"description": "Config file for the documentation of a TanStack project.",
"type": "object",
"required": ["sections"],
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"docSearch": {
"deprecated": true,
"description": "Ignored. tanstack.com no longer reads this — the site's search client and index are configured in SearchModal.tsx, not per-library. Safe to delete from your config.",
"type": "object",
"properties": {
"appId": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"indexName": {
"type": "string"
}
}
},
"sections": {
"description": "Section groups for the sidebar.",
"type": "array",
"items": {
"type": "object",
"required": ["label", "children"],
"additionalProperties": false,
"properties": {
"label": {
"type": "string"
},
"tab": {
"$ref": "#/$defs/tab",
"description": "Default docs nav tab for every child in this section. Individual children can override it."
},
"children": {
"description": "Framework-agnostic docs go here.",
"type": "array",
"items": {
"type": "object",
"required": ["label", "to"],
"additionalProperties": false,
"properties": {
"label": {
"type": "string"
},
"to": {
"type": "string"
},
"badge": {
"type": "string",
"description": "Free-form tag appended to this page's entry in the generated llms.txt (e.g. \"experimental\"). Not shown in the sidebar — the sidebar overwrites this with the page's framework provenance."
},
"addedAt": {
"type": "string",
"format": "date",
"description": "Date the page was added (e.g. \"2026-06-01\"). Shows a \"New\" pill in the sidebar for 7 days."
},
"updatedAt": {
"type": "string",
"format": "date",
"description": "Date the page was last meaningfully updated (e.g. \"2026-06-01\"). Shows an \"Updated\" pill in the sidebar for 7 days."
},
"tab": {
"$ref": "#/$defs/tab",
"description": "Docs nav tab this page belongs to. Overrides the section's `tab`. Omit to let the site infer one from the labels and path."
}
}
}
},
"frameworks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": { "type": "string" },
"children": {
"description": "Framework-specific docs go here.",
"type": "array",
"items": {
"type": "object",
"required": ["label", "to"],
"additionalProperties": false,
"properties": {
"label": {
"type": "string"
},
"to": {
"type": "string"
},
"badge": {
"type": "string",
"description": "Free-form tag appended to this page's entry in the generated llms.txt (e.g. \"experimental\"). Not shown in the sidebar — the sidebar overwrites this with the page's framework provenance."
},
"addedAt": {
"type": "string",
"format": "date",
"description": "Date the page was added (e.g. \"2026-06-01\"). Shows a \"New\" pill in the sidebar for 7 days."
},
"updatedAt": {
"type": "string",
"format": "date",
"description": "Date the page was last meaningfully updated (e.g. \"2026-06-01\"). Shows an \"Updated\" pill in the sidebar for 7 days."
},
"tab": {
"$ref": "#/$defs/tab",
"description": "Docs nav tab this page belongs to. Overrides the section's `tab`. Omit to let the site infer one from the labels and path."
}
}
}
}
},
"required": ["label", "children"],
"additionalProperties": false
}
},
"collapsible": {
"type": "boolean",
"default": false,
"description": "Whether the section should be collapsible."
},
"defaultCollapsed": {
"type": "boolean",
"default": false,
"description": "Whether the section should be collapsed by default."
}
}
}
},
"users": {
"type": "array",
"items": {
"type": "string"
}
}
},
"$defs": {
"tab": {
"description": "One of the docs nav tabs rendered above the sidebar.",