Skip to content

Commit d49a121

Browse files
docs: add type-doc and update docs config (#329)
Co-authored-by: Sam Willis <[email protected]>
1 parent cb2fb70 commit d49a121

File tree

233 files changed

+29147
-348
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

233 files changed

+29147
-348
lines changed

docs/config.json

Lines changed: 139 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,158 @@
2121
"label": "Installation",
2222
"to": "installation"
2323
}
24+
],
25+
"frameworks": [
26+
{
27+
"label": "react",
28+
"children": [
29+
{
30+
"label": "React Adapter",
31+
"to": "framework/react/adapter"
32+
}
33+
]
34+
},
35+
{
36+
"label": "solid",
37+
"children": [
38+
{
39+
"label": "Solid Adapter",
40+
"to": "framework/solid/adapter"
41+
}
42+
]
43+
},
44+
{
45+
"label": "vue",
46+
"children": [
47+
{
48+
"label": "Vue Adapter",
49+
"to": "framework/vue/adapter"
50+
}
51+
]
52+
},
53+
{
54+
"label": "svelte",
55+
"children": [
56+
{
57+
"label": "Svelte Adapter",
58+
"to": "framework/svelte/adapter"
59+
}
60+
]
61+
}
2462
]
2563
},
2664
{
2765
"label": "Guides",
2866
"children": [
2967
{
3068
"label": "Live Queries",
31-
"to": "live-queries"
69+
"to": "guides/live-queries"
3270
},
3371
{
3472
"label": "Error Handling",
35-
"to": "error-handling"
73+
"to": "guides/error-handling"
3674
},
3775
{
3876
"label": "Creating Collection Options Creators",
39-
"to": "collection-options-creator"
77+
"to": "guides/collection-options-creator"
78+
}
79+
]
80+
},
81+
{
82+
"label": "API Reference",
83+
"children": [
84+
{
85+
"label": "Core API Reference",
86+
"to": "reference/index"
87+
},
88+
{
89+
"label": "Collection",
90+
"to": "reference/interfaces/collection"
91+
},
92+
{
93+
"label": "createCollection",
94+
"to": "reference/functions/createcollection"
95+
},
96+
{
97+
"label": "liveQueryCollectionOptions",
98+
"to": "reference/functions/livequerycollectionoptions"
99+
},
100+
{
101+
"label": "createLiveQueryCollection",
102+
"to": "reference/functions/createlivequerycollection"
103+
},
104+
{
105+
"label": "createOptimisticAction",
106+
"to": "reference/functions/createoptimisticaction"
107+
},
108+
{
109+
"label": "createTransaction",
110+
"to": "reference/functions/createtransaction"
111+
},
112+
{
113+
"label": "Electric DB Collection",
114+
"to": "reference/electric-db-collection/index"
115+
},
116+
{
117+
"label": "electricCollectionOptions",
118+
"to": "reference/electric-db-collection/functions/electriccollectionoptions"
119+
},
120+
{
121+
"label": "Query DB Collection",
122+
"to": "reference/query-db-collection/index"
123+
},
124+
{
125+
"label": "queryCollectionOptions",
126+
"to": "reference/query-db-collection/functions/querycollectionoptions"
127+
}
128+
],
129+
"frameworks": [
130+
{
131+
"label": "react",
132+
"children": [
133+
{
134+
"label": "React Hooks",
135+
"to": "framework/react/reference/index"
136+
},
137+
{
138+
"label": "useLiveQuery",
139+
"to": "framework/react/reference/functions/uselivequery"
140+
}
141+
]
142+
},
143+
{
144+
"label": "solid",
145+
"children": [
146+
{
147+
"label": "Solid Hooks",
148+
"to": "framework/solid/reference/index"
149+
},
150+
{
151+
"label": "useLiveQuery",
152+
"to": "framework/solid/reference/functions/uselivequery"
153+
}
154+
]
155+
},
156+
{
157+
"label": "vue",
158+
"children": [
159+
{
160+
"label": "Vue Composables",
161+
"to": "framework/vue/reference/index"
162+
},
163+
{
164+
"label": "useLiveQuery",
165+
"to": "framework/vue/reference/functions/uselivequery"
166+
},
167+
{
168+
"label": "UseLiveQueryReturn",
169+
"to": "framework/vue/reference/interfaces/uselivequeryreturn"
170+
},
171+
{
172+
"label": "UseLiveQueryReturnWithCollection",
173+
"to": "framework/vue/reference/interfaces/uselivequeryreturnwithcollection"
174+
}
175+
]
40176
}
41177
]
42178
}

0 commit comments

Comments
 (0)