@@ -219,6 +219,240 @@ sidebar:
219
219
---
220
220
```
221
221
222
+ #### <span class = " text-lg font-bold" >` tableOfContents ` (optional)</span >
223
+
224
+ ** type:** ` object `
225
+
226
+ Controls the table of contents display for the page.
227
+
228
+ ``` md title="example.mdx"
229
+ ---
230
+ title: Example Article
231
+ page_id: 12345678-1234-1234-1234-123456789012
232
+ tableOfContents:
233
+ maxHeadingLevel: 3
234
+ ---
235
+ ```
236
+
237
+ #### <span class = " text-lg font-bold" >` topics ` (optional)</span >
238
+
239
+ ** type:** ` array `
240
+
241
+ Array of topic tags that help categorize the content.
242
+
243
+ ``` md title="example.mdx"
244
+ ---
245
+ title: Example Article
246
+ page_id: 12345678-1234-1234-1234-123456789012
247
+ topics:
248
+ - contribute
249
+ - documentation
250
+ - community
251
+ ---
252
+ ```
253
+
254
+ #### <span class = " text-lg font-bold" >` description ` (optional)</span >
255
+
256
+ ** type:** ` string `
257
+
258
+ A brief description of the article content, used for SEO and metadata.
259
+
260
+ ``` md title="example.mdx"
261
+ ---
262
+ title: Example Article
263
+ page_id: 12345678-1234-1234-1234-123456789012
264
+ description: "Comprehensive guide to example functionality including setup, configuration, and best practices."
265
+ ---
266
+ ```
267
+
268
+ #### <span class = " text-lg font-bold" >` sdk ` (optional)</span >
269
+
270
+ ** type:** ` array `
271
+
272
+ Array of SDKs that are relevant to this article. Use ` [] ` for no SDKs or ` null ` for not applicable.
273
+
274
+ ``` md title="example.mdx"
275
+ ---
276
+ title: Example Article
277
+ page_id: 12345678-1234-1234-1234-123456789012
278
+ sdk: []
279
+ ---
280
+ ```
281
+
282
+ #### <span class = " text-lg font-bold" >` languages ` (optional)</span >
283
+
284
+ ** type:** ` array `
285
+
286
+ Array of programming languages covered in the article.
287
+
288
+ ``` md title="example.mdx"
289
+ ---
290
+ title: Example Article
291
+ page_id: 12345678-1234-1234-1234-123456789012
292
+ languages:
293
+ - javascript
294
+ - typescript
295
+ - python
296
+ ---
297
+ ```
298
+
299
+ #### <span class = " text-lg font-bold" >` audience ` (optional)</span >
300
+
301
+ ** type:** ` string ` or ` array `
302
+
303
+ Target audience for the article. Can be a single value or array.
304
+
305
+ ``` md title="example.mdx"
306
+ ---
307
+ title: Example Article
308
+ page_id: 12345678-1234-1234-1234-123456789012
309
+ audience: developers
310
+ # or
311
+ audience:
312
+ - developers
313
+ - admins
314
+ - product managers
315
+ ---
316
+ ```
317
+
318
+ #### <span class = " text-lg font-bold" >` complexity ` (optional)</span >
319
+
320
+ ** type:** ` string `
321
+
322
+ Difficulty level of the content. Common values: ` beginner ` , ` intermediate ` , ` advanced ` .
323
+
324
+ ``` md title="example.mdx"
325
+ ---
326
+ title: Example Article
327
+ page_id: 12345678-1234-1234-1234-123456789012
328
+ complexity: beginner
329
+ ---
330
+ ```
331
+
332
+ #### <span class = " text-lg font-bold" >` keywords ` (optional)</span >
333
+
334
+ ** type:** ` array `
335
+
336
+ Array of keywords for search optimization.
337
+
338
+ ``` md title="example.mdx"
339
+ ---
340
+ title: Example Article
341
+ page_id: 12345678-1234-1234-1234-123456789012
342
+ keywords:
343
+ - example
344
+ - guide
345
+ - tutorial
346
+ - setup
347
+ ---
348
+ ```
349
+
350
+ #### <span class = " text-lg font-bold" >` updated ` (optional)</span >
351
+
352
+ ** type:** ` string `
353
+
354
+ Date when the article was last updated in YYYY-MM-DD format.
355
+
356
+ ``` md title="example.mdx"
357
+ ---
358
+ title: Example Article
359
+ page_id: 12345678-1234-1234-1234-123456789012
360
+ updated: 2024-01-15
361
+ ---
362
+ ```
363
+
364
+ #### <span class = " text-lg font-bold" >` featured ` (optional)</span >
365
+
366
+ ** type:** ` boolean `
367
+
368
+ Whether the article should be featured in special displays.
369
+
370
+ ``` md title="example.mdx"
371
+ ---
372
+ title: Example Article
373
+ page_id: 12345678-1234-1234-1234-123456789012
374
+ featured: false
375
+ ---
376
+ ```
377
+
378
+ #### <span class = " text-lg font-bold" >` deprecated ` (optional)</span >
379
+
380
+ ** type:** ` boolean `
381
+
382
+ Whether the article content is deprecated.
383
+
384
+ ``` md title="example.mdx"
385
+ ---
386
+ title: Example Article
387
+ page_id: 12345678-1234-1234-1234-123456789012
388
+ deprecated: false
389
+ ---
390
+ ```
391
+
392
+ #### <span class = " text-lg font-bold" >` ai-summary ` (optional)</span >
393
+
394
+ ** type:** ` string `
395
+
396
+ A summary of the article content for AI processing and search.
397
+
398
+ ``` md title="example.mdx"
399
+ ---
400
+ title: Example Article
401
+ page_id: 12345678-1234-1234-1234-123456789012
402
+ ai-summary: "Comprehensive guide to example functionality including setup, configuration, and best practices."
403
+ ---
404
+ ```
405
+
406
+ #### <span class = " text-lg font-bold" >` relatedArticles ` (optional)</span >
407
+
408
+ ** type:** ` array `
409
+
410
+ Array of page IDs for related articles that should be displayed at the bottom of the page.
411
+
412
+ ``` md title="example.mdx"
413
+ ---
414
+ title: Example Article
415
+ page_id: 12345678-1234-1234-1234-123456789012
416
+ relatedArticles:
417
+ - 9fa41f57-5ee7-4c8b-a401-f5384e8db1bb
418
+ - 8b1b2198-e919-484a-846b-e89422178707
419
+ ---
420
+ ```
421
+
422
+ #### <span class = " text-lg font-bold" >` app_context ` (optional)</span >
423
+
424
+ ** type:** ` array `
425
+
426
+ Used to map documentation to specific application contexts within the Kinde platform. This helps with navigation and contextual linking.
427
+
428
+ ``` md title="example.mdx"
429
+ ---
430
+ title: Example Article
431
+ page_id: 12345678-1234-1234-1234-123456789012
432
+ app_context:
433
+ - m: properties
434
+ s: properties
435
+ ---
436
+ ```
437
+
438
+ The ` app_context ` field uses:
439
+ - ` m ` : Module (e.g., ` properties ` , ` billing ` , ` authenticate ` )
440
+ - ` s ` : Section (e.g., ` properties ` , ` plans ` , ` organizations ` )
441
+
442
+ #### <span class = " text-lg font-bold" >` social_sharing_image_url ` (optional)</span >
443
+
444
+ ** type:** ` string `
445
+
446
+ URL for a custom image to be used when the article is shared on social media platforms.
447
+
448
+ ``` md title="example.mdx"
449
+ ---
450
+ title: Example Article
451
+ page_id: 12345678-1234-1234-1234-123456789012
452
+ social_sharing_image_url: "https://example.com/share-image.jpg"
453
+ ---
454
+ ```
455
+
222
456
<Divider />
223
457
224
458
### Code samples
0 commit comments