Гайды Домена

Как писать документы

Минимальный пример ручной работы с MDX

MDX сочетает обычный Markdown и React-компоненты. Для первой проверки достаточно изменить этот файл и сохранить его — локальный сервер обновит страницу автоматически.

Обычный Markdown

  • заголовки создаются через #;
  • списки — через -;
  • ссылки — через квадратные и круглые скобки;
  • примеры кода — через тройные обратные кавычки.
Example.tsx
export function Example() {
  return <p>Первая документация в Lore</p>;
}

Компоненты Fumadocs

Следующим шагом можно заменить этот текст первым реальным документом проекта.

On this page