Една от най-важните задачи при създаването на софтуер е документацията, за съжаление на тези от нас, които разработваме тази работа, понякога изглежда досадно, но не е тайна, че добрата документация може да бъде точката на успех на всеки инструмент, тъй като Или за помощта, която се предоставя на потребителите да разберат правилната работа на приложението, или информацията, която се предоставя на други разработчици за подобряването му.
Има доста добри приложения, които ни позволяват да документираме нашите проекти по прост начин, някои са склонни да предлагат повече, отколкото наистина искаме, а други изискват сложни инсталации, инструмент за документиране на проекти който отговаря и е доста лесен за използване и инсталиране е Docusaurus.
Какво е Docusaurus?
Докузавър е проект за изграждане, внедряване и поддържане на уеб документация за инструменти с отворен код, позволява да се използва езикът Markdown За да напишем документацията, която по-късно ще бъде публикувана като html уебсайт, по същия начин инструментът ни позволява да разширим и персонализираме дизайна на нашия уебсайт за документация с помощта на React.
Като цяло, този инструмент с отворен код, разработен от екипа за програмиране на Facebook, ни позволява лесно да създаваме красиви и леки уебсайтове, където можем правилно да показваме документацията на всеки проект.
Инструментът е оборудван с функционалности за правилната версия на документи, усъвършенствана търсачка, възможност за документиране и препроектиране на нашия сайт за документация в реално време, интеграция с преводи и много други функции, които ще ви помогнат да се тревожите по-малко за документиране или по-скоро за улесняване на процеса на документиране и с по-приятен завършек.
Лесното използване на Docusaurus може да се види в следващия gif, разпространен от неговите разработчици
Как да инсталирам Docusaurus?
Основната цел на Docusaurus е да бъде окончателният инструмент за документиране на приложения с отворен код, хоствани на github, така че е много лесно да инсталирате и стартирате вашия уебсайт за документация на тази платформа.
За да започнете да се наслаждавате на Docusaurus на Github, просто следвайте стъпките, посочени от екипа за разработка и които цитираме по-долу:
- Отидете до корена на вашата директория на хранилището на GitHub, където ще създадете документите и изпълнете следните команди:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
Крайният резултат ще бъде създаването на файл и структура на директории, както е показано по-долу:
Интересна грешка, която да опитате!