jazzy

Soulful docs for Swift & Objective-C

MIT License

Downloads
3M
Stars
7.3K
Committers
63
View Code on GitHub Visit Website View on X
Ecosystems: Ruby, Swift

Bot releases are hidden (Show)

jazzy - 0.15.1 Latest Release

Published by johnfairh 4 months ago

Breaking
  • None.
Enhancements
  • None.
Bug Fixes
jazzy - 0.15.0

Published by johnfairh 6 months ago

Breaking
  • None.
Enhancements

  • Update Javascript: typeahead.js 1.3.4, KaTeX 0.16.10
    John Fairhurst

  • Support Swift 5.10 with Swift Package Manager projects.
    John Fairhurst
    #1381

  • Support documentation of multiple modules in a single website. Use --modules or the config-file modules for more control. See the README 'Documenting multiple modules' for more details.
    Argjira Mala
    Pedro Alcobia
    John Fairhurst
    #564

  • Improve page breadcrumbs to include parent pages and indicate source module of extensions from other modules.
    John Fairhurst

  • Add --readme-title and --docset-title to set the titles of the readme docs page and the Dash docset independently of the module name.
    John Fairhurst

  • Support Swift 5.9 symbolgraph extension symbols.
    John Fairhurst
    #1368

Bug Fixes
jazzy - 0.14.4

Published by johnfairh about 1 year ago

Breaking
  • None.
Enhancements

  • Update Javascript: jQuery 3.7.1, KaTeX 0.16.8
    John Fairhurst

  • Support Swift package access control level.
    John Fairhurst

  • Initial support for Swift macro declarations. Requires
    --swift-build-tool symbolgraph.
    John Fairhurst

  • Support Swift @_documentation(visibility:) attribute. Requires
    --swift-build-tool spm|xcodebuild.
    John Fairhurst

Bug Fixes
jazzy - 0.14.3

Published by johnfairh about 2 years ago

Breaking
  • None.
Enhancements
Bug Fixes
  • None.
jazzy - 0.14.2

Published by johnfairh over 2 years ago

Breaking
  • When building with Swift 5.6 and not passing —-module to Jazzy, declarations may not be correctly identified as undocumented and docs may include unwanted extensions. Pass —-module MyModuleName to fix this.
    John Fairhurst
Enhancements

  • Support using pre-generated symbolgraph files in Swift symbolgraph mode.
    Nathan Wong

  • Issue a warning on some combinations of Objective-C flags.
    John Fairhurst
    #900

  • Support Swift 5.6. The bundled sourcekitten is a universal binary.
    John Fairhurst

Bug Fixes
  • In Swift symbolgraph mode, stop including extensions to types that are beneath the minimum ACL.
    John Fairhurst
    #1291
jazzy - 0.14.1

Published by johnfairh about 3 years ago

Breaking
  • Support Swift SPI groups. Swift declarations marked @_spi are no longer included in docs when --min-acl is set to public or open. Use --include-spi-declarations to include docs for these declarations.
    John Fairhurst
    #1263
Enhancements
Bug Fixes
jazzy - 0.14.0

Published by johnfairh about 3 years ago

Breaking
  • Require at least Ruby 2.6.3.
Enhancements

  • Support DocC-style autolinks and callouts in markdown.
    John Fairhurst

  • Add --source-host option to support projects hosted on GitLab and Bitbucket as well as GitHub. Options --source-host-url and --source-host-files-url and new Mustache tags replace the 'github' versions which remain as back-compatibility aliases.
    John Fairhurst
    #314

  • Add rel="noopener" to all target="_blank" links.
    JP Simard

Bug Fixes

  • Fix source-host line number references in Swift symbolgraph mode, and
    in ObjC mode for references to one-line declarations.
    John Fairhurst

  • Fix crash with ` ` in markdown.
    John Fairhurst
    #1270

  • Fix symbolgraph mode with Xcode 13.
    John Fairhurst

jazzy - 0.13.7

Published by johnfairh over 3 years ago

0.13.7

The next release of Jazzy will require a minimum of Ruby 2.6.

Breaking
  • None.
Enhancements
Bug Fixes
jazzy - 0.13.6

Published by johnfairh almost 4 years ago

Breaking
  • None.
Enhancements
  • Support documentation generation from .swiftmodule binaries using
    --swift-build-tool symbolgraph with Swift 5.3.
    John Fairhurst
Bug Fixes
jazzy - 0.13.5

Published by johnfairh over 4 years ago

Breaking
  • None.
Enhancements

  • Add search function to apple theme.
    Giles Payne
    #726

  • Add option --[no-]separate-global-declarations to always create separate
    documentation pages for top-level declarations as well as classes,
    structures, enums etc. even if they don't have members. As part of this,
    improve the main page declaration in all modes.
    Nikolay Volosatov
    John Fairhurst

Bug Fixes
jazzy - 0.13.4

Published by johnfairh over 4 years ago

Breaking
  • None.
Enhancements
  • Update JavaScript libraries: jQuery 3.5.1 (all themes), Lunr 2.3.8,
    typeahead.js 1.3.1 (fullwidth theme only).
    John Fairhurst
Bug Fixes
jazzy - 0.13.3

Published by johnfairh over 4 years ago

Breaking
  • None.
Enhancements

  • Added a config option to provide sources of privately hosted pod
    dependencies when using the --podspec option.
    --pod-sources url1,url2,…urlN.
    Jonathan Bailey
    #650

  • Improve Dash docset support: support online redirection when
    --root-url is set, and provide --docset-playground-url to
    support docset playground links.
    John Fairhurst

Bug Fixes
jazzy - 0.13.2

Published by johnfairh over 4 years ago

Breaking
  • None.
Enhancements

  • Support Xcode 11.4. Default Objective-C property attributes are now
    stripped from declarations: turn this off with
    --keep-default-property-attributes.
    John Fairhurst
    #829

  • Render LaTeX expressions written using $equation$ or $$equation$$
    syntax.
    Arthur Guiot
    John Fairhurst
    #1156

  • Wrap long method names on category pages. Use name_html in custom
    mustache templates to take advantage of this.
    John Fairhurst
    #995

  • Support Dash-style apple_ref links to specific API items, for more
    stable and human-readable links from external docs.
    Paul Cantrell
    #1167

Bug Fixes
jazzy - 0.13.1

Published by jpsim almost 5 years ago

Breaking
  • None.
Enhancements

  • Allow inline html tags in ObjC doc comments.
    Chris Williams
    #976

  • Support code formatting in ObjC doc comments with @c, @code and
    @endcode.
    Bryce Pauken
    jpsim/SourceKitten#631

  • Add custom_categories_unlisted_prefix configuration setting. This
    is the prefix for navigation section names that aren't explicitly
    listed in custom_categories. Defaults to 'Other '.
    JP Simard

  • Add hide_unlisted_documentation configuration setting. Setting this
    to true hides documentation entries in the sidebar from the
    documentation config value that aren't explicitly listed in
    custom_categories.
    JP Simard

Bug Fixes

  • Fix crash when SourceKit returns out of bounds string byte offsets.
    JP Simard

  • Pick the right version of declarations with type attributes.
    John Fairhurst
    #1148

jazzy - 0.13.0

Published by johnfairh almost 5 years ago

Breaking
  • None.
Enhancements

  • Add section headings for members added by Swift conditional conformances.
    John Fairhurst
    #717

  • Parse markdown in MARK comments, make the html available to themes via
    name_html mustache tag key for section headings.
    John Fairhurst

  • Include protocol conformances added by extensions in Swift docs.
    John Fairhurst

Bug Fixes
jazzy - 0.12.0

Published by johnfairh almost 5 years ago

Breaking
  • None.
Enhancements
  • Support for mixed Swift-ObjC modules: generate two sets of SourceKitten
    json and pass them on using --sourcekitten-sourcefile.
    Joe Susnick
    John Fairhurst
    #447
Bug Fixes
jazzy - 0.11.2

Published by johnfairh about 5 years ago

Breaking
  • None.
Enhancements
  • None.
Bug Fixes
jazzy - 0.11.1

Published by johnfairh about 5 years ago

Breaking
  • None.
Enhancements
  • None.
Bug Fixes
  • Don't use SwiftPM if there is an Xcode workspace or project in a non-root
    directory.
    John Fairhurst
    #1103
jazzy - 0.11.0

Published by jpsim about 5 years ago

Breaking
  • None.
Enhancements

  • Sass support now provided by libsass via sassc instead of the
    deprecated Ruby Sass gem.
    John Fairhurst

  • Update bundled jQuery to 3.4.1 (all themes).
    Paul Idstein

  • Support Xcode 11 Swift projects that pass a response file to the Swift
    compiler.
    John Fairhurst
    #1087

  • Generate Swift docs from a Swift Package Manager package without
    requiring an Xcode project file. Add --swift-build-tool to choose
    the build method if both .xcodeproj and Package.swift files are
    present. Add --build-tool-flags as a preferred alias for
    --xcodebuild-flags.
    John Fairhurst
    #487

Bug Fixes
jazzy - 0.10.0

Published by johnfairh over 5 years ago

Breaking
  • The included sourcekitten binary is built with Xcode 10.2. This means
    it does not run on macOS earlier than 10.14.4 without the Swift 5 Runtime
    Support for Command Line Tools     being installed.
    John Fairhurst
Enhancements

  • Support CocoaPods 1.6+. Use the swift_version[s] dsl in --podspec mode
    to set the Swift language version.
    John Fairhurst

  • Show the extension declaration when documenting Swift extensions.
    John Fairhurst

  • Allow docs title customization. Include --module-version when it is set
    and support --title to fully customize the title. Pass {{module_version}}
    and {{docs_title}} to templates.
    Maximilian Alexander
    John Fairhurst
    #666
    #411

Bug Fixes
Package Rankings
Top 2.12% on Rubygems.org
Top 4.12% on Proxy.golang.org
Badges
Extracted from project README
Build Status