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

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

Настройки MDX-документа

MDX-документы хранятся в папках apps/content/docs/[language] и apps/content/blog/[language]. Каждый документ — это MDX-файл с заголовком метаданных, например title и description. Ниже приведен пример заголовка документа:

---
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-сервер не запущен
• Меняете структуру организации контента

Команда запускается автоматически при сборке проекта для production, но во время разработки ее нужно запускать вручную, если вы вносите структурные изменения в контент.