Fumadocs

Fumadocs — це фреймворк для документації, який допомагає розробникам створювати професійні сайти документації за допомогою React та Next.js. На відміну від традиційних інструментів для документації, він дає вам повний контроль над вашим контентом і дизайном, автоматично обробляючи складні частини.

Він підтримує написання контенту у форматах Markdown та MDX, що означає, що ви можете використовувати просте текстове форматування або додавати інтерактивні компоненти React. Фреймворк включає вбудований пошук, підсвічування синтаксису та красиві заздалегідь розроблені теми. Він також працює з будь-яким джерелом контенту, незалежно від того, чи зберігаєте ви свої документи у файлах, базі даних або системі управління контентом.

Fumadocs побудований на трьох частинах: шар контенту для управління вашою документацією, основна бібліотека для функцій, таких як пошук, та бібліотека UI для красивих компонентів. Ви можете використовувати лише те, що вам потрібно.

Почати роботу з Fumadocs дуже просто. Ось кроки:

• Встановіть фреймворк, виконавши команду npm create fumadocs-app у вашому терміналі. Оберіть бажаний React-фреймворк та джерело контенту, коли буде запропоновано.

• Напишіть свій контент у файлах MDX у папці docs. Використовуйте простий синтаксис Markdown з можливістю додавати React-компоненти для інтерактивних елементів.

• Налаштуйте зовнішній вигляд за допомогою Tailwind CSS. Ви можете змінювати кольори, макети та стилі, щоб відповідати вашому бренду, не вивчаючи нову систему.

• Додайте функцію пошуку, підключивши Orama або Algolia пошук за допомогою кількох рядків коду. Фреймворк автоматично обробить усе інше.

• Використовуйте CLI-інструмент для додавання інтерактивних компонентів, таких як вкладки, виклики уваги та блоки коду, за допомогою команди npx @fumadocs/cli add.

• Розгорніть свій сайт на Vercel, Netlify або будь-якому хостингу, що підтримує додатки Next.js.

• Безкоштовний та відкритий фреймворк

• Працює з Next.js, React Router та іншими фреймворками React

• Пишіть контент у Markdown та MDX

• Вбудований пошук з підтримкою Orama та Algolia

• Генератор документації OpenAPI

• Інтеграція TypeScript Twoslash

• Красиві заздалегідь розроблені UI-компоненти

• Інструмент командного рядка для легкого налаштування

• Підсвічування синтаксису з Shiki

• Висока налаштовуваність з Tailwind CSS