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