{{ message }}
Repository navigation
Expand file tree
/
Copy pathcontentlayer.config.js
More file actions
375 lines (364 loc) · 9.29 KB
/
Copy pathcontentlayer.config.js
File metadata and controls
375 lines (364 loc) · 9.29 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
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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
import {
defineDocumentType,
defineNestedType,
makeSource,
} from '@contentlayer/source-files'
import rehypeKatex from 'rehype-katex'
import remarkMath from 'remark-math'
const Author = defineNestedType(() => ({
name: 'Author',
fields: {
name: {
type: 'string',
description: 'The name of the author.',
required: true,
},
picture: {
type: 'string',
description: 'The picture of the author.',
required: false,
},
},
}))
const OgImage = defineNestedType(() => ({
name: 'OgImage',
description: 'The og:image of the blog post, for SEO and preview image use.',
fields: {
url: {
type: 'string',
description: 'The url of the og:image.',
required: true,
},
},
}))
const Page = defineDocumentType(() => ({
name: 'Page',
filePathPattern: `pages/**/*.mdx`,
contentType: 'mdx',
fields: {
title: {
type: 'string',
description: 'The title of the page, for SEO and heading use.',
required: true,
},
excerpt: {
type: 'string',
description: 'The excerpt of the page, for SEO and preview text use.',
required: true,
},
layout: {
type: 'enum',
options: ['manual'],
description: 'The layout of the page.',
required: false,
}
},
computedFields: {
slug: {
type: 'string',
resolve: (doc) => doc._raw.sourceFileName.replace(/\.mdx?$/, ''),
},
},
}))
const Doc = defineDocumentType(() => ({
name: 'Doc',
filePathPattern: `pages/docs/**/*.md*`,
contentType: 'mdx',
fields: {
title: {
type: 'string',
description: 'The title of the tutorial, for SEO and heading use.',
required: true,
},
excerpt: {
type: 'string',
description: 'The excerpt of the tutorial, for SEO and preview text use.',
required: true,
},
langs: {
type: 'list',
of: {
type: 'enum',
options: ['go', 'ts', 'py', 'rs'],
},
description: 'The programming languages the tutorial is available in.',
required: false,
},
tags: {
type: 'list',
of: {
type: 'string',
},
description: 'The tags of the tutorial, for SEO and filtering use.',
required: false,
},
sidebarPosition: {
type: 'number',
description:
'The position of the doc in the sidebar. The lower the number, the higher the position.',
required: false,
},
subtitle: {
type: 'string',
description: 'Subtitle for the doc, used in the page body.',
required: false,
},
layout: {
type: 'enum',
options: ['manual'],
description: 'The layout of the page.',
required: false,
},
synonyms: {
type: 'list',
of: {
type: 'string',
},
description: 'Synonyms of the primary term.',
required: false,
},
domains: {
type: 'list',
of: {
type: 'enum',
options: ['software-engineering', 'hardware-engineering'],
},
description: 'Subject domain(s) of the primary term.',
required: false,
}
},
computedFields: {
slug: {
type: 'string',
resolve: (doc) => doc._raw.sourceFileName.replace(/\.(?:md|mdx)$/i, ''),
},
slugs: {
type: 'list',
resolve: (doc) => {
const paths = doc._raw.sourceFilePath
.replace('pages/docs/', '')
.replace(/\.(?:md|mdx)$/i, '')
.split('/')
// If we end the array on "index", we remove it.
if (paths[paths.length - 1] === 'index') {
paths.pop()
}
return paths
},
},
},
}))
const BlogPost = defineDocumentType(() => ({
name: 'BlogPost',
filePathPattern: `posts/*.md*`,
contentType: 'mdx',
description:
'A blog post. You may use MDX Markdown with any of the following components from the website repo: MarkDownAPITokens, TokenReplacementNote',
fields: {
title: {
type: 'string',
description: 'The title of the blog post, for SEO and heading use.',
required: true,
},
excerpt: {
type: 'string',
description:
'The excerpt of the blog post, for SEO and preview text use.',
required: true,
},
coverImage: {
type: 'string',
description:
'The cover image of the blog post, for SEO and preview image use.',
required: false,
},
date: {
type: 'date',
description: 'The date of the blog post.',
required: true,
},
author: {
type: 'nested',
of: Author,
description: 'The author of the blog post.',
required: true,
},
ogImage: {
type: 'nested',
of: OgImage,
description:
'The og:image of the blog post, for SEO and preview image use.',
required: false,
},
tags: {
type: 'list',
of: {
type: 'string',
},
description: 'The tags of the blog post, for SEO, categorization, and filtering use.',
required: false,
},
draft: {
type: 'boolean',
description: 'Whether the blog post is a draft and should not be published.',
required: false,
default: false,
},
},
computedFields: {
slug: {
type: 'string',
resolve: (doc) => doc._raw.sourceFileName.replace(/\.mdx?$/, ''),
},
},
}))
const ResearchPage = defineDocumentType(() => ({
name: 'ResearchPage',
filePathPattern: `research/*.md*`,
contentType: 'mdx',
description:
'A research page. You may use MDX Markdown with any of the following components from the website repo: MarkDownAPITokens, TokenReplacementNote',
fields: {
title: {
type: 'string',
description: 'The title of the research page, for SEO and heading use.',
required: true,
},
shortTitle: {
type: 'string',
description: 'The short title of the research page, for navigation use.',
required: true,
},
excerpt: {
type: 'string',
description:
'The excerpt of the research page, for SEO and preview text use.',
required: true,
},
coverImage: {
type: 'string',
description:
'The cover image of the research page, for SEO and preview image use.',
required: false,
},
date: {
type: 'date',
description: 'The date of the research page.',
required: true,
},
author: {
type: 'nested',
of: Author,
description: 'The author of the research page.',
required: true,
},
additionalContributors: {
type: 'string',
description:
'Additional contributors to the research page, for attribution purposes.',
required: false,
},
ogImage: {
type: 'nested',
of: OgImage,
description:
'The og:image of the research page, for SEO and preview image use.',
required: false,
},
tags: {
type: 'list',
of: {
type: 'string',
},
description: 'The tags of the research page, for SEO, categorization, and filtering use.',
required: false,
},
},
computedFields: {
slug: {
type: 'string',
resolve: (doc) => doc._raw.sourceFileName.replace(/\.mdx?$/, ''),
},
},
}))
const PressPage = defineDocumentType(() => ({
name: 'PressPage',
filePathPattern: `press/*.md*`,
contentType: 'mdx',
description:
'A press page. You may use MDX Markdown with any of the following components from the website repo: MarkDownAPITokens, TokenReplacementNote',
fields: {
title: {
type: 'string',
description: 'The title of the press page, for SEO and heading use.',
required: true,
},
subTitle: {
type: 'string',
description: 'The subtitle of the press page, for SEO and heading use.',
required: false,
},
shortTitle: {
type: 'string',
description: 'The short title of the press page, for navigation use.',
required: true,
},
excerpt: {
type: 'string',
description:
'The excerpt of the press page, for SEO and preview text use.',
required: true,
},
coverImage: {
type: 'string',
description:
'The cover image of the press page, for SEO and preview image use.',
required: false,
},
date: {
type: 'date',
description: 'The date of the press page.',
required: true,
},
author: {
type: 'nested',
of: Author,
description: 'The author of the press page.',
required: true,
},
ogImage: {
type: 'nested',
of: OgImage,
description:
'The og:image of the press page, for SEO and preview image use.',
required: false,
},
tags: {
type: 'list',
of: {
type: 'string',
},
description: 'The tags of the press page, for SEO, categorization, and filtering use.',
required: false,
},
},
computedFields: {
slug: {
type: 'string',
resolve: (doc) => doc._raw.sourceFileName.replace(/\.mdx?$/, ''),
},
},
}))
export default makeSource({
contentDirPath: 'content',
// Order of these maters because Page is greedy.
documentTypes: [BlogPost, Doc, Page, PressPage, ResearchPage],
disableImportAliasWarning: true,
contentDirExclude: ['**/README.md', '**/manifest.json'],
mdx: {
remarkPlugins: [
remarkMath, // Parses $...$ and $$...$$.
],
rehypePlugins: [[rehypeKatex, { output: 'htmlAndMathml' }]],
},
})
You can’t perform that action at this time.