-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathastro.config.mjs
217 lines (215 loc) · 10.3 KB
/
astro.config.mjs
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
import { defineConfig } from "astro/config";
import sitemap from "@astrojs/sitemap";
import starlight from "@astrojs/starlight";
import { rehypeHeadingIds } from '@astrojs/markdown-remark';
import rehypeAutolinkHeadings from "rehype-autolink-headings";
import starlightLinksValidator from "starlight-links-validator";
const site = "https://docs.kuzudb.com";
// https://astro.build/config
export default defineConfig({
site,
integrations: [
sitemap(),
starlight({
favicon: '/img/favicon.ico',
title: 'Kùzu',
logo: {
light: '/src/assets/logo/kuzu-logo.png',
dark: '/src/assets/logo/kuzu-logo-inverse.png',
replacesTitle: true,
},
social: {
github: 'https://github.com/kuzudb/kuzu',
discord: 'https://discord.gg/jw7xN2ZhJB',
twitter: 'https://twitter.com/kuzudb',
linkedin: 'https://www.linkedin.com/company/101059770',
youtube: 'https://youtube.com/@kuzudb',
},
editLink: {
baseUrl: 'https://github.com/kuzudb/kuzu-docs/edit/main',
},
customCss: ['./src/styles/custom.css'],
expressiveCode: true,
head: [
{
tag: 'meta',
attrs: { property: 'og:image', content: site + '/img/og.png' },
},
{
tag: 'meta',
attrs: { property: 'twitter:image', content: site + '/img/og.png' },
},
],
components: {
Header: './src/components/overrides/Header.astro',
},
sidebar: [
{
label: 'Home',
link: '/',
},
{
label: 'Install Kùzu',
collapsed: true,
items: [
{ label: 'Install Kùzu', link: '/installation', },
{ label: 'System requirements', link: '/system-requirements'},
]
},
{
label: 'Get started',
collapsed: false,
items: [
{ label: 'Create your first graph', link: '/get-started' },
{ label: 'Query & visualize your graph', link: '/get-started/cypher-intro' },
{ label: 'Run prepared Cypher statements', link: '/get-started/prepared-statements' },
{ label: 'Run graph algorithms', link: '/get-started/graph-algorithms' },
]
},
{
label: 'Import data',
collapsed: true,
items: [
{
label: 'Copy from files/formats',
items: [
{ label: 'Overview', link: '/import' },
{ label: 'Copy from CSV', link: '/import/csv' },
{ label: 'Copy from Parquet', link: '/import/parquet' },
{ label: 'Copy from NumPy', link: '/import/npy' },
{ label: 'Copy from DataFrame', link: '/import/copy-from-dataframe' },
{ label: 'Copy from subquery', link: '/import/copy-from-subquery' },
{ label: 'Copy from JSON', link: '/import/copy-from-json' },
]
},
{ label: 'Merge', link: '/import/merge' },
]
},
{
label: 'Export data',
collapsed: true,
items: [
{ label: 'Overview', link: '/export' },
{ label: 'Copy to CSV', link: '/export/csv' },
{ label: 'Copy to Parquet', link: '/export/parquet' },
{ label: 'Copy to JSON', link: '/export/json', badge: { text: 'New'}},
]
},
{
label: 'Migrate your database',
collapsed: true,
items: [
{ label: 'Overview', link: '/migrate' },
]
},
{
label: 'Visualize graphs',
collapsed: true,
items: [
{ label: 'Intro to Kùzu Explorer', link: '/visualization'},
{ label: 'Shell panel', link: '/visualization/shell-panel'},
{ label: 'Schema panel', link: '/visualization/schema-panel' },
{ label: 'Import panel', link: '/visualization/import-panel' },
{ label: 'Settings panel', link: '/visualization/settings-panel' },
],
autogenerate: { directory: 'reference' },
},
{
label: 'Cypher manual',
collapsed: true,
items: [
{ label: 'Overview', link: '/cypher'},
{ label: 'Syntax', link: '/cypher/syntax'},
{ label: 'Data types', link: '/cypher/data-types'},
{ label: 'Query clauses', link: '/cypher/query-clauses' },
{ label: 'Functions, expressions & operators', link: '/cypher/expressions' },
{ label: 'Data definition language (DDL)', link: '/cypher/data-definition' },
{ label: 'Data manipulation clauses', link: '/cypher/data-manipulation-clauses' },
{ label: 'Subqueries', link: '/cypher/subquery' },
{ label: 'Macros', link: '/cypher/macro' },
{ label: 'Transactions', link: '/cypher/transaction' },
{ label: 'Attach/Detach To External Databases', link: '/cypher/attach' },
{ label: 'Configuration', link: '/cypher/configuration' },
],
autogenerate: { directory: 'reference' },
},
{
label: 'Use client APIs',
collapsed: true,
items: [
{ label: 'Overview', link: '/client-apis/' },
{ label: 'CLI', link: '/client-apis/cli' },
{ label: 'Python', link: '/client-apis/python' },
{ label: 'Node.js', link: '/client-apis/nodejs' },
{ label: 'Java', link: '/client-apis/java' },
{ label: 'Rust', link: '/client-apis/rust' },
{ label: 'Go', link: '/client-apis/go' },
{ label: 'C++', link: '/client-apis/cpp' },
{ label: 'C', link: '/client-apis/c' },
{ label: '.NET', link: '/client-apis/net', badge: { text: 'Community', variant: 'caution'}},
{ label: 'Elixir', link: '/client-apis/elixir', badge: { text: 'Community', variant: 'caution'}}
],
},
{ label: 'Connections & concurrency', link: '/concurrency' },
{
label: 'Tutorials',
collapsed: true,
items: [
{
label: 'Learning resources',
link: '/tutorials#python',
}
]
},
{
label: 'Developer guide',
collapsed: true,
items: [
{ label: 'Build Kùzu from source', link: '/developer-guide' },
{ label: 'Performance debugging', link: '/developer-guide/performance-debugging' },
{ label: 'Testing framework', link: '/developer-guide/testing-framework' },
{ label: 'Join order hints', link: '/developer-guide/join-order-hint' },
{
label: 'Database internals',
items: [
{ label: 'Overview', link: '/developer-guide/database-internal' },
{ label: 'Data types', link: '/developer-guide/database-internal/datatype' },
{ label: 'Vector types', link: '/developer-guide/database-internal/vector' },
{ label: 'Execution', link: '/developer-guide/database-internal/execution' },
]
}
]
},
{
label: 'Extensions',
collapsed: true,
items: [
{ label: 'Overview', link: '/extensions'},
{ label: 'HTTP File System (httpfs)', link: '/extensions/httpfs'},
{
label: 'External databases',
items: [
{ label: 'Overview', link: '/extensions/attach' },
{ label: 'External Kùzu databases', link: '/extensions/attach/kuzu' },
{ label: 'External relational databases ', link: '/extensions/attach/rdbms' },
]
},
{ label: 'JSON', link: '/extensions/json' },
{ label: 'Iceberg', link: '/extensions/iceberg', badge: { text: 'New' }},
{ label: 'Delta Lake', link: '/extensions/delta', badge: { text: 'New' }},
],
autogenerate: { directory: 'reference' },
},
],
plugins: process.env.CHECK_LINKS
? [
starlightLinksValidator({
errorOnFallbackPages: true,
errorOnInconsistentLocale: true,
}),
]
: [],
lastUpdated: true,
}),
],
});