Для документації

1. Створіть новий файл .mdx у папці apps/content/docs/[language] із вмістом вашого документа.
2. Додайте документ до навігаційного меню сайту. Для цього додайте новий елемент у файл src/config/docs.ts у властивість sidebarNav з потрібною інформацією, дотримуючись шаблону наявних елементів. Після цього документ також буде додано до палітри команд пошуку.

Налаштування MDX документа

MDX документи зберігаються в папках apps/content/docs/[language] і apps/content/blog/[language]. Кожен документ є MDX файлом, що містить заголовок із метаданими, такими як назва й опис. Нижче наведено приклад заголовка документа:

---
title: Document Title
description: Document Description.
sort: 1
---

Підтримуються такі поля метаданих:

• title (обов’язково): назва документа.
• description (обов’язково): короткий опис документа.
• sort (необов’язково): число, яке визначає порядок документа в навігації. Документи з меншими значеннями sort показуються першими. Якщо не вказано, документи сортуються за назвою в алфавітному порядку.
• links (необов’язково): посилання на пов’язані документи, API довідники, вихідний код тощо.
• toc (необов’язково): чи показувати зміст. За замовчуванням true.

Щоб додати до документа нові метадані, ви можете додати нові ключі до заголовка. Наприклад, можна додати ключ author, щоб указати автора документа:

---
title: Document Title
description: Document Description.
sort: 2
author: Author Name
---

Але під час додавання власних метаданих також потрібно оновити файл contentlayer.config.ts, розташований у корені проєкту, і властивість fields у константах Doc або Blog. Після цього потрібно показати нову інформацію в шаблоні документа. Для цього оновіть файл src/app/[locale]/docs/[[...slug]]/page.tsx, або src/app/[locale]/blog/[[...slug]]/page.tsx, або один із його дочірніх компонентів.

Перебудова Contentlayer

Коли ви змінюєте вміст документації, додаєте нові документи або змінюєте файл contentlayer.config.ts, потрібно перебудувати кеш contentlayer, щоб зміни набули чинності під час розробки. Виконайте:

cd apps/web
pnpm contentlayer:build

Ця команда повторно генерує типи вмісту та дані, потрібні застосунку. Її потрібно запускати щоразу, коли ви:

• Додаєте нові поля метаданих до файлу contentlayer.config.ts
• Додаєте або змінюєте MDX вміст, коли dev server не запущений
• Змінюєте структуру організації вмісту

Команда автоматично запускається під час збірки проєкту для production, але під час розробки її потрібно запускати вручну, якщо ви вносите структурні зміни до вмісту.