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 мов

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

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

• Швидке генерування статичних сайтів

• Легке розгортання на будь-якому хості