Docusaurus

Docusaurus — это генератор статических сайтов, созданный с использованием React и Node.js. Он берет ваши файлы Markdown и создает полноценный сайт документации со всеми необходимыми функциями, которые ожидают пользователи. В отличие от создания сайта с нуля, Docusaurus берет на себя сложные задачи.

Инструмент использует MDX, что означает, что вы можете добавлять интерактивные React-компоненты прямо в ваши файлы Markdown. Это делает вашу документацию более увлекательной без дополнительной работы. В комплекте есть встроенный поиск на базе Algolia, управление версиями для разных релизов продукта и поддержка более 70 языков с помощью инструментов перевода.

Поскольку он создает статические файлы, ваша документация загружается быстро и может быть размещена где угодно. Сайты отлично работают на мобильных устройствах и соответствуют современным веб-стандартам по скорости и доступности.

Начать работу с Docusaurus просто и занимает всего несколько минут:

• Установите Node.js версии 20 или выше на свой компьютер, затем выполните команду настройки в терминале, чтобы создать новый сайт.

• Пишите документацию в файлах Markdown внутри папки docs. Каждый файл становится страницей на вашем сайте.

• Настройте внешний вид, редактируя файл конфигурации. Вы можете изменить цвета, добавить логотип и настроить меню навигации.

• Используйте команду локального предварительного просмотра, чтобы сразу видеть изменения в браузере во время работы.

• Добавляйте записи в блог, создавая файлы Markdown в папке blog с датами в имени файла.

• Когда будете готовы к публикации, выполните команду сборки для генерации статических файлов, затем загрузите их на любой веб-хостинг, например GitHub Pages, Netlify или Vercel.

В инструменте есть подробные руководства и полезное сообщество, если у вас возникнут трудности.

• Бесплатный и с открытым исходным кодом под лицензией MIT

• Создан с использованием React и Node.js

• Пишите контент в Markdown и MDX

• Встроенный поиск с Algolia DocSearch

• Управление версиями для релизов продукта

• Поддержка более 70 языков

• Блог и документация на одном сайте

• Темный режим и адаптивный дизайн

• Быстрая генерация статических сайтов

• Простое развертывание на любом хостинге