Repository navigation
Expand file tree
/
Copy pathtanstack-docs-config.schema.json
More file actions
152 lines (152 loc) · 5.62 KB
/
Copy pathtanstack-docs-config.schema.json
File metadata and controls
152 lines (152 loc) · 5.62 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://github.com/TanStack/tanstack.com/blob/main/tanstack-docs-config.schema.json",
"title": "TanStack Docs Config",
"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.",
"type": "string",
"enum": ["home", "get-started", "tutorial", "guides", "api", "examples"]
}
}
}