CODEDOC описание, скриншоты и видео

CODEDOC — это инструмент с открытым исходным кодом, который помогает создавать красивую и современную документацию по программному обеспечению. Он создает приложение JAMStack из ваших файлов уценки, которое вы можете легко развернуть в таких сервисах, как GitHub Pages.

Настраиваемость
Легко изменяйте любой аспект ваших документов, от цветов темы и шрифтов до метаданных каждой страницы и их макетов. Создайте свой собственный заголовок или ToC с компонентами на основе JSX/TSX или используйте пользовательские компоненты на основе JSX-TSX в уценке.

Компонентная структура codedoc просто означает, что вы даже можете повторно использовать свои пользовательские компоненты в разных проектах или опубликовать их (например, в NPM), чтобы другие люди тоже могли ими пользоваться!

Интегрированный поиск
Если ваш проект находится на GitHub, codedoc по умолчанию включает функцию поиска между документами с использованием API поиска GitHub. Вы также можете легко интегрировать свои собственные поисковые API в компоненты поиска по умолчанию (помимо возможности фактически использовать свои собственные настраиваемые компоненты поиска).

Встроенный темный режим
На дворе 2020 год, и темный режим следует считать универсальным правом! Codedoc поддерживает темный режим для всех ваших документов. Настройки устройства используются по умолчанию, но ваши читатели могут изменить это вручную.

Совместный
Все уценено, поэтому вы можете легко работать над документацией проекта со своими коллегами, используя любое программное обеспечение для контроля версий, такое как Git. Нет необходимости в полусырых странных визуальных интерфейсах сверху!

Открытый исходный код
Codedoc — это инструмент с открытым исходным кодом, полностью бесплатный для использования, с лицензией MIT, без каких-либо условий. Мне просто нужен был этот инструмент, чтобы написать полезную документацию для некоторых проектов с открытым исходным кодом, над которыми я работал.