Repolode
Enviar
realm

realm/jazzy

Ferramenta de linha de comando que gera documentação de API em HTML no estilo da Apple para projetos Swift e Objective-C.

Ver no GitHubSite
Estrelas
7,381
Forks
413
Issues abertas
74
Último commit
mês passado

O que é?

jazzy gera documentação de referência de API para código Swift e Objective-C. Em vez de analisar os arquivos-fonte diretamente, usa Clang e SourceKit para ler a AST do código e os comentários de documentação, buscando gerar resultados precisos. As páginas geradas seguem o visual da documentação de referência oficial da Apple.

A ferramenta roda no macOS e oferece suporte a projetos do Xcode e do Swift Package Manager. Também pode gerar documentação a partir de módulos Swift compilados, usando o symbol graph; esse método é mais rápido do que ler o código-fonte, mas cobre apenas declarações públicas. É possível combinar vários módulos em um único site com busca e links entre módulos. A saída também pode incluir guias em Markdown, fórmulas renderizadas com KaTeX e um docset do Dash.

A configuração é feita por meio de um arquivo `.jazzy.yaml` ou de opções de linha de comando. A ferramenta inclui três temas (apple, fullwidth e jony) e oferece suporte a temas personalizados.

Recursos principais

  • 01Gera documentação lendo as ASTs do Clang e do SourceKit, além dos comentários de documentação.
  • 02Oferece suporte a projetos do Xcode e do Swift Package Manager, além de Objective-C.
  • 03Pode gerar documentação a partir de módulos Swift compilados, usando symbol graphs.
  • 04Combina vários módulos em um único site com links entre eles.
  • 05Renderiza fórmulas LaTeX com KaTeX e inclui guias em Markdown.
  • 06Gera docsets do Dash e oferece três temas integrados.

Casos de uso

  • Publicar documentação de referência de API para um framework ou SDK Swift.
  • Documentar uma biblioteca Objective-C com um umbrella header.
  • Gerar um único site de documentação para um app e suas extensões.
  • Criar documentação offline como um docset do Dash.

Início rápido

  1. 1

    Instale jazzy com RubyGems

    [sudo] gem install jazzy
  2. 2

    Execute jazzy a partir da raiz do seu projeto Swift

    jazzy

Antes de usar

  • O Jazzy foi projetado para ser executado no macOS; para usá-lo no Linux, consulte as dicas adicionais do README.

Em coleções

Apps open source para MacGeradores de sites estáticos e ferramentas de documentação

Tópicos

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

Perguntas frequentes

O que é jazzy?
Ferramenta de linha de comando que gera documentação de API em HTML no estilo da Apple para projetos Swift e Objective-C. jazzy gera documentação de referência de API para código Swift e Objective-C. Em vez de analisar os arquivos-fonte diretamente, usa Clang e SourceKit para ler a AST do código e os comentários de documentação, buscando gerar resultados precisos. As páginas geradas seguem o visual da documentação de referência oficial da Apple.
jazzy é gratuito? Qual é a licença?
jazzy é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
jazzy ainda é mantido?
Atualizado nos últimos 6 meses. O último commit de jazzy foi em 1 de out. de 2026.
Para que posso usar jazzy?
Publicar documentação de referência de API para um framework ou SDK Swift. Documentar uma biblioteca Objective-C com um umbrella header. Gerar um único site de documentação para um app e suas extensões. Criar documentação offline como um docset do Dash.
Como instalar jazzy?
Instale jazzy com RubyGems: [sudo] gem install jazzy Execute jazzy a partir da raiz do seu projeto Swift: jazzy
Onde consigo jazzy?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/realm/jazzy

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados