Одним з найважливіших завдань при створенні програмного забезпечення є документація, на жаль для тих з нас, хто розробляє цю роботу, іноді це здається нудним, але ні для кого не секрет, що хороша документація може бути точкою успіху будь-якого інструменту, оскільки допомога, яка надається користувачам для розуміння правильної роботи програми або інформації, що надається іншим розробникам для її вдосконалення.
Є досить хороші додатки, які дозволяють нам просто задокументувати наші проекти, деякі, як правило, пропонують більше, ніж те, що ми справді хочемо, а інші вимагають складної інсталяції, інструмент для документування проектів що відповідає і досить простий у використанні та встановленні - це Docusaurus.
Що таке Докузавр?
Докузавр це проект для створювати, впроваджувати та підтримувати веб-документацію щодо інструментів з відкритим кодом, це дозволяє використовувати мову Markdown Для написання документації, яка згодом буде опублікована як веб-сайт html, таким же чином, інструмент дозволяє нам розширити та налаштувати дизайн нашого веб-сайту з документацією за допомогою React.
Загалом, цей інструмент з відкритим кодом, розроблений командою програмістів Facebook, дозволяє нам легко створювати красиві та легкі веб-сайти, де ми можемо правильно відображати документацію будь-якого проекту.
Інструмент оснащений функціоналами для правильної версії документів, вдосконаленою пошуковою системою, можливістю документування та переробки нашого документаційного сайту в режимі реального часу, інтеграцією з перекладами та багатьма іншими функціями, які допоможуть менше турбуватися про документування чи, швидше, про створення процес документування простіший та приємніший.
Просте використання Docusaurus можна побачити у наступному gif, який розповсюджують його розробники
Як встановити Docusaurus?
Основна мета Docusaurus - бути остаточним інструментом для документування програм з відкритим кодом, розміщених на github, тому встановити та запустити веб-сайт з документацією на цій платформі дуже просто.
Щоб почати насолоджуватися Docusaurus на Github, просто виконайте дії, зазначені командою розробників, і які ми цитуємо нижче:
- Перейдіть до кореневого каталогу вашого сховища GitHub, де ви будете створювати документи та виконувати такі команди:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
Кінцевим результатом буде створення файлу та структури каталогів, як показано нижче:
Цікава помилка спробувати!