Repolode
Предложить
realm

realm/jazzy

CLI-утилита для генерации HTML-документации API в стиле Apple для проектов на Swift и Objective-C.

Открыть на GitHubСайт
Звёзды
7,381
Форки
413
Открытые issues
74
Последний коммит
в прошлом месяце

Что это?

jazzy генерирует справочную документацию API для кода на Swift и Objective-C. Вместо прямого разбора исходных файлов утилита использует Clang и SourceKit, чтобы читать AST кода вместе с комментариями к документации и добиваться точного результата. Сгенерированные страницы оформлены в стиле официальной справочной документации Apple.

Утилита работает на macOS и поддерживает проекты Xcode и Swift Package Manager. Она также может создавать документацию по скомпилированным модулям Swift на основе графа символов: это быстрее, чем читать исходный код, но охватывает только публичные объявления. Несколько модулей можно объединить на одном сайте с поиском и ссылками между модулями. В документацию также можно включить руководства в Markdown, формулы, отрисованные с помощью KaTeX, и docset для Dash.

Настройки задаются в файле `.jazzy.yaml` или через флаги командной строки. Доступны три встроенные темы (apple, fullwidth, jony), а также поддерживаются пользовательские темы.

Ключевые возможности

  • 01Генерирует документацию, читая AST Clang и SourceKit и комментарии к документации.
  • 02Поддерживает проекты Xcode и Swift Package Manager, а также Objective-C.
  • 03Может создавать документацию по скомпилированным модулям Swift с помощью графов символов.
  • 04Объединяет несколько модулей на одном сайте со ссылками между ними.
  • 05Отображает формулы LaTeX с помощью KaTeX и включает руководства в Markdown.
  • 06Создаёт docset для Dash и предлагает три встроенные темы.

Сценарии использования

  • Публикация справочной документации API для фреймворка или SDK на Swift.
  • Документирование библиотеки Objective-C с umbrella header.
  • Создание единого сайта с документацией для приложения и его расширений.
  • Подготовка офлайн-документации в формате docset для Dash.

Быстрый старт

  1. 1

    Установите jazzy с помощью RubyGems

    [sudo] gem install jazzy
  2. 2

    Запустите jazzy из корневой папки проекта Swift

    jazzy

Что важно знать

  • Jazzy рассчитан на запуск в macOS; для использования в Linux потребуются дополнительные рекомендации из README.

В подборках

Open source приложения для MacГенераторы статических сайтов и инструменты для документации

Темы

#swift#objective-c#documentation#api-docs#xcode#macos#code-generation#ruby#sourcekit#sourcekitten

Частые вопросы

Что такое jazzy?
CLI-утилита для генерации HTML-документации API в стиле Apple для проектов на Swift и Objective-C. jazzy генерирует справочную документацию API для кода на Swift и Objective-C. Вместо прямого разбора исходных файлов утилита использует Clang и SourceKit, чтобы читать AST кода вместе с комментариями к документации и добиваться точного результата. Сгенерированные страницы оформлены в стиле официальной справочной документации Apple.
jazzy можно использовать бесплатно? Какая у него лицензия?
jazzy распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.
jazzy всё ещё поддерживается?
Обновлялся за последние 6 месяцев. Последний коммит в jazzy — 1 окт. 2026 г..
Для чего можно использовать jazzy?
Публикация справочной документации API для фреймворка или SDK на Swift. Документирование библиотеки Objective-C с umbrella header. Создание единого сайта с документацией для приложения и его расширений. Подготовка офлайн-документации в формате docset для Dash.
Как установить jazzy?
Установите jazzy с помощью RubyGems: [sudo] gem install jazzy Запустите jazzy из корневой папки проекта Swift: jazzy
Где скачать jazzy?
Исходный код и инструкции по установке — на GitHub: https://github.com/realm/jazzy

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты

doxygen / doxygen

Doxygen генерирует документацию по размеченному исходному коду, а также строит диаграммы структуры и зависимостей даже для кода без комментариев.

Инструменты разработчика#documentation#code-documentation#api-docs
6,6 тыс.+6 за неделю1,4 тыс.C++GPL-2.0Активно поддерживаетсяОбновлён 5 часов назад