forked from github/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
frontmatter.js
301 lines (290 loc) · 7.31 KB
/
frontmatter.js
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
import parse from './read-frontmatter.js'
import { allVersions } from '#src/versions/lib/all-versions.js'
import { allTools } from '#src/tools/lib/all-tools.js'
import { getDeepDataByLanguage } from './get-data.js'
const layoutNames = [
'default',
'graphql-explorer',
'product-landing',
'product-guides',
'release-notes',
'inline',
false,
]
const guideTypes = ['overview', 'quick_start', 'tutorial', 'how_to', 'reference']
export const schema = {
type: 'object',
required: ['title', 'versions'],
additionalProperties: false,
properties: {
title: {
type: 'string',
translatable: true,
},
shortTitle: {
type: 'string',
translatable: true,
},
intro: {
type: 'string',
translatable: true,
},
product: {
type: 'string',
translatable: true,
},
permissions: {
type: 'string',
translatable: true,
},
// true by default on articles, false on all other content
showMiniToc: {
type: 'boolean',
},
// This frontmatter property is deprecated. Despite what `miniTocMaxHeadingLevel` says, the max level of mini TOC is *always* 2. See github/docs-engineering#2701.
miniTocMaxHeadingLevel: {
deprecated: true,
type: 'number',
default: 2,
minimum: 2,
maximum: 4,
},
mapTopic: {
type: 'boolean',
},
// allow hidden articles under `early-access`
hidden: {
type: 'boolean',
},
// specify whether an Early Access article should not have a header notice
noEarlyAccessBanner: {
type: 'boolean',
},
// specify whether an Early Acccess product should have a table of contents
// (EA categories and map topics have them by default, but products don't)
earlyAccessToc: {
type: 'boolean',
},
layout: {
type: ['string', 'boolean'],
enum: layoutNames,
errorMessage: 'must be the filename of an existing layout file, or `false` for no layout',
},
redirect_from: {
type: 'array',
},
allowTitleToDifferFromFilename: {
type: 'boolean',
},
introLinks: {
type: 'object',
},
authors: {
type: 'array',
items: {
type: 'string',
},
},
examples_source: {
type: 'string',
},
effectiveDate: {
type: 'string',
},
featuredLinks: {
type: 'object',
properties: {
gettingStarted: {
type: 'array',
items: { type: 'string' },
},
startHere: {
type: 'array',
items: { type: 'string' },
},
guideCards: {
type: 'array',
items: { type: 'string' },
},
popular: {
type: 'array',
items: { type: 'string' },
},
// allows you to use an alternate heading for the popular column
popularHeading: {
type: 'string',
},
videos: {
type: 'array',
items: {
type: 'object',
properties: {
title: {
type: 'string',
},
href: {
type: 'string',
},
},
},
},
// allows you to use an alternate heading for the videos column
videosHeading: {
type: 'string',
},
},
},
// Shown in `product-landing.html` "What's new" section
changelog: {
type: 'object',
properties: {
label: { type: 'string' },
prefix: { type: 'string' },
},
},
type: {
type: 'string',
enum: guideTypes,
},
topics: {
type: 'array',
},
includeGuides: {
type: 'array',
},
learningTracks: {
type: 'array',
},
// Used in `product-landing.html`
beta_product: {
type: 'boolean',
},
// Show in `product-landing.html`
product_video: {
type: 'string',
},
// Show in `product-landing.html`
product_video_transcript: {
type: 'string',
},
interactive: {
type: 'boolean',
},
communityRedirect: {
type: 'object',
properties: {
name: {
type: 'string',
},
href: {
type: 'string',
},
},
},
// Platform-specific content preference
defaultPlatform: {
type: 'string',
enum: ['mac', 'windows', 'linux'],
},
// Tool-specific content preference, the list of tools are kept in
// make it easier to update in a single place
defaultTool: {
type: 'string',
enum: Object.keys(allTools),
},
// Child groups specified on top-level TOC
childGroups: {
type: 'array',
},
// Child links specified on any TOC page
children: {
type: 'array',
},
// External products specified on the homepage
externalProducts: {
type: 'object',
required: ['electron'],
properties: {
electron: {
type: 'object',
required: ['id', 'name', 'href', 'external'],
properties: {
id: { type: 'string' },
name: { type: 'string' },
href: { type: 'string', format: 'url' },
external: { type: 'boolean' },
},
},
},
},
// whether or not the page is mirrored by an experimental page
hasExperimentalAlternative: {
type: 'boolean',
},
// Translation metadata properties added during the translation process,
// we don't use these properties ourselves.
'ms.openlocfilehash': {
type: 'string',
},
'ms.sourcegitcommit': {
type: 'string',
},
'ms.translationtype': {
type: 'string',
},
'ms.contentlocale': {
type: 'string',
},
'ms.lasthandoff': {
type: 'string',
},
'ms.locfileid': {
type: 'string',
},
autogenerated: {
type: 'string',
enum: ['codeql-cli', 'github-apps', 'graphql', 'rest', 'webhooks'],
},
},
}
// returns a list of deprecated properties
export const deprecatedProperties = Object.keys(schema.properties).filter((prop) => {
return schema.properties[prop].deprecated
})
const featureVersionsProp = {
feature: {
type: ['string', 'array'],
enum: Object.keys(getDeepDataByLanguage('features', 'en')),
items: {
type: 'string',
},
errorMessage:
'must be the name (or names) of a feature that matches "filename" in data/features/_filename_.yml',
},
}
const semverRange = {
type: 'string',
format: 'semver',
// This is JSON pointer syntax with ajv so we can specify the bad version
// in the error message.
// eslint-disable-next-line no-template-curly-in-string
errorMessage: 'Must be a valid SemVer range: ${0}',
}
schema.properties.versions = {
type: ['object', 'string'], // allow a '*' string to indicate all versions
additionalProperties: false, // don't allow any versions in FM that aren't defined in lib/all-versions
properties: Object.values(allVersions).reduce((acc, versionObj) => {
acc[versionObj.plan] = semverRange
acc[versionObj.shortName] = semverRange
return acc
}, featureVersionsProp),
}
export function frontmatter(markdown, opts = {}) {
const defaults = {
schema,
}
return parse(markdown, Object.assign({}, defaults, opts))
}
// attach the schema object so it can be `require`d elsewhere.
frontmatter.schema = schema
export default frontmatter