{"id":28559013,"url":"https://github.com/sdwebimage/jazzy-theme","last_synced_at":"2025-06-10T08:35:55.439Z","repository":{"id":136287169,"uuid":"291712033","full_name":"SDWebImage/jazzy-theme","owner":"SDWebImage","description":"SDWebImage documentation theme for Jazzy","archived":false,"fork":false,"pushed_at":"2020-11-11T10:31:37.000Z","size":408,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-04T02:37:49.168Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SDWebImage.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-08-31T12:41:14.000Z","updated_at":"2020-09-01T02:36:40.000Z","dependencies_parsed_at":"2023-04-09T03:35:31.619Z","dependency_job_id":null,"html_url":"https://github.com/SDWebImage/jazzy-theme","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SDWebImage%2Fjazzy-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SDWebImage%2Fjazzy-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SDWebImage%2Fjazzy-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SDWebImage%2Fjazzy-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SDWebImage","download_url":"https://codeload.github.com/SDWebImage/jazzy-theme/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SDWebImage%2Fjazzy-theme/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259039508,"owners_count":22796848,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-10T08:35:54.623Z","updated_at":"2025-06-10T08:35:55.352Z","avatar_url":"https://github.com/SDWebImage.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![jazzy](images/logo.jpg)\n\n[![Build Status](https://circleci.com/gh/realm/jazzy.svg?style=svg)](https://circleci.com/gh/realm/jazzy)\n\n*jazzy is a command-line utility that generates documentation for Swift or Objective-C*\n\n## Usage\n\nUsing the jazzy command line with the `--theme` arg, specify the path to the theme folder.\n\n```bash\njazzy \\\n ... \\\n --theme themes/apple\n```\n\n## About\n\nBoth Swift and Objective-C projects are supported.\n\n*SwiftPM support was recently added, so please report any issues you find.*\n\nInstead of parsing your source files, `jazzy` hooks into [Clang][clang] and\n[SourceKit][sourcekit] to use the [AST][ast] representation of your code and\nits comments for more accurate results. The output matches the look and feel\nof Apple’s official reference documentation, post WWDC 2014.\n\n![Screenshot](images/screenshot.jpg)\n\nThis project adheres to the [Contributor Covenant Code of Conduct](https://realm.io/conduct).\nBy participating, you are expected to uphold this code. Please report\nunacceptable behavior to [info@realm.io](mailto:info@realm.io).\n\n## Requirements\n\nYou need development tools to build the project you wish to document.  Jazzy supports\nboth [Xcode][xcode] and [Swift Package Manager][spm] projects.\n\nJazzy expects to be running on __macOS__.  See [below](#linux) for tips to run Jazzy\non Linux.\n\n## Installation\n\n```shell\n[sudo] gem install jazzy\n```\n\nSee [Installation Problems](#installation-problems) for solutions to some\ncommon problems.\n\n## Usage\n\nRun `jazzy` from your command line. Run `jazzy -h` for a list of additional options.\n\nIf your Swift module is the first thing to build, and it builds fine when running\n`xcodebuild` or `swift build` without any arguments from the root of your project, then\njust running `jazzy` (without any arguments) from the root of your project should\nsucceed too!\n\nIf Jazzy generates docs for the wrong module then use `--module` to tell it which\none you'd prefer.  If this doesn't help, and you're using Xcode, then try passing\nextra arguments to `xcodebuild`, for example `jazzy --build-tool-arguments -target,MyTarget`.\n\nYou can set options for your project’s documentation in a configuration file,\n`.jazzy.yaml` by default. For a detailed explanation and an exhaustive list of\nall available options, run `jazzy --help config`.\n\n### Supported keywords\n\nSwift documentation is written in markdown and supports a number of special keywords.\nFor a complete list and examples, see Erica Sadun's post on [*Swift header documentation in Xcode 7*](https://ericasadun.com/2015/06/14/swift-header-documentation-in-xcode-7/),\nher [book on Swift Documentation Markup](https://itunes.apple.com/us/book/swift-documentation-markup/id1049010423), and the [Xcode Markup Formatting Reference](https://developer.apple.com/library/content/documentation/Xcode/Reference/xcode_markup_formatting_ref/).\n\nFor Objective-C documentation the same keywords are supported, but note that the format\nis slightly different. In Swift you would write `- returns:`, but in Objective-C you write `@return`. See Apple's [*HeaderDoc User Guide*](https://developer.apple.com/legacy/library/documentation/DeveloperTools/Conceptual/HeaderDoc/tags/tags.html) for more details. **Note: `jazzy` currently does not support _all_ Objective-C keywords listed in this document, only @param, @return, @warning, @see, and @note.**\n\nJazzy can also generate cross-references within your documentation. A symbol name in\nbackticks generates a link, for example:\n* \\`MyClass\\` - a link to documentation for `MyClass`.\n* \\`MyClass.method(param1:)\\` - a link to documentation for that method.\n* \\`MyClass.method(...)\\` - shortcut syntax for the same thing.\n* \\`method(...)\\` - shortcut syntax to link to `method` from the documentation of another\n  method or property in the same class.\n* \\`[MyClass method1]\\` - a link to an Objective-C method.\n* \\`-[MyClass method2:param1]\\` - a link to another Objective-C method.\n\n### Math\n\nJazzy can render math equations written in LaTeX embedded in your markdown:\n* `` `$equation$` `` renders the equation in an inline style.\n* `` `$$equation$$` `` renders the equation in a display style, centered on a\n  line of its own.\n\nFor example, the markdown:\n```markdown\nInline: `$ax^2+bx+c=0$`\n\nBlock: `$$x={\\frac {-b\\pm {\\sqrt {b^{2}-4ac}}}{2a}}$$`\n```\n..renders as:\n\n![math](images/math.png)\n\nMath support is provided by [KaTeX](https://katex.org).\n\n### Swift\n\nSwift documentation is generated by default.\n\n##### Example\n\nThis is how Realm Swift docs are generated:\n\n```shell\njazzy \\\n  --clean \\\n  --author Realm \\\n  --author_url https://realm.io \\\n  --github_url https://github.com/realm/realm-cocoa \\\n  --github-file-prefix https://github.com/realm/realm-cocoa/tree/v0.96.2 \\\n  --module-version 0.96.2 \\\n  --build-tool-arguments -scheme,RealmSwift \\\n  --module RealmSwift \\\n  --root-url https://realm.io/docs/swift/0.96.2/api/ \\\n  --output docs/swift_output \\\n  --theme docs/themes\n```\n\nThis is how docs are generated for a project that uses the Swift Package Manager:\n\n```shell\njazzy \\\n  --module DeckOfPlayingCards \\\n  --swift-build-tool spm \\\n  --build-tool-arguments -Xswiftc,-swift-version,-Xswiftc,5\n```\n\n### Objective-C\n\nTo generate documentation for Objective-C headers, you must pass the following\nparameters to jazzy:\n\n* `--objc`\n* `--umbrella-header ...`\n* `--framework-root ...`\n* `--sdk [iphone|watch|appletv][os|simulator]|macosx` (optional, default value\n   of `macosx`)\n* `--hide-declarations [objc|swift]` (optional, hides the selected language\n   declarations)\n\n##### Example\n\nThis is how Realm Objective-C docs are generated:\n\n```shell\njazzy \\\n  --objc \\\n  --clean \\\n  --author Realm \\\n  --author_url https://realm.io \\\n  --github_url https://github.com/realm/realm-cocoa \\\n  --github-file-prefix https://github.com/realm/realm-cocoa/tree/v2.2.0 \\\n  --module-version 2.2.0 \\\n  --build-tool-arguments --objc,Realm/Realm.h,--,-x,objective-c,-isysroot,$(xcrun --show-sdk-path),-I,$(pwd) \\\n  --module Realm \\\n  --root-url https://realm.io/docs/objc/2.2.0/api/ \\\n  --output docs/objc_output \\\n  --head \"$(cat docs/custom_head.html)\"\n```\n\nThis is how the AFNetworking docs are generated:\n\n```shell\njazzy \\\n  --objc \\\n  --author AFNetworking \\\n  --author_url http://afnetworking.com \\\n  --github_url https://github.com/AFNetworking/AFNetworking \\\n  --github-file-prefix https://github.com/AFNetworking/AFNetworking/tree/2.6.2 \\\n  --module-version 2.6.2 \\\n  --umbrella-header AFNetworking/AFNetworking.h \\\n  --framework-root . \\\n  --module AFNetworking\n```\n\n### Mixed Objective-C / Swift\n\n*This feature is new and has some rough edges.*\n\nTo generate documentation for a mixed Swift and Objective-C project you must first\ngenerate two [SourceKitten][sourcekitten] files: one for Swift and one for Objective-C.\n\nThen pass these files to Jazzy together using `--sourcekitten-sourcefile`.\n\n#### Example\n\nThis is how docs are generated from an Xcode project for a module containing both\nSwift and Objective-C files:\n\n```shell\n# Generate Swift SourceKitten output\nsourcekitten doc -- -workspace MyProject.xcworkspace -scheme MyScheme \u003e swiftDoc.json\n\n# Generate Objective-C SourceKitten output\nsourcekitten doc --objc $(pwd)/MyProject/MyProject.h \\\n      -- -x objective-c  -isysroot $(xcrun --show-sdk-path --sdk iphonesimulator) \\\n      -I $(pwd) -fmodules \u003e objcDoc.json\n\n# Feed both outputs to Jazzy as a comma-separated list\njazzy --sourcekitten-sourcefile swiftDoc.json,objcDoc.json\n```\n\n### Themes\n\nThree themes are provided with jazzy: `apple` (default), `fullwidth` and `jony`.\n\n* `apple` example: \u003chttps://realm.io/docs/swift/latest/api/\u003e\n* `fullwidth` example: \u003chttps://reduxkit.github.io/ReduxKit/\u003e\n* `jony` example: \u003chttps://harshilshah.github.io/IGListKit/\u003e\n\nYou can specify which theme to use by passing in the `--theme` option. You can\nalso provide your own custom theme by passing in the path to your theme\ndirectory.\n\n### Guides\n\n| Description | Command |\n| ---         | ---     |\n| Command line option | `--documentation={file pattern}` |\n| Example             | `--documentation=Docs/*.md` |\n| jazzy.yaml example  | `documentation: Docs/*.md` |\n\nBy default, jazzy looks for one of README.md, README.markdown, README.mdown or README (in that order) in the directory from where it runs to render the index page at the root of the docs output directory.\nUsing the `--documentation` option, extra markdown files can be integrated into the generated docs and sidebar navigation.\n\nAny files found matching the file pattern will be parsed and included as a document with the type 'Guide' when generated. If the files are not included using the `custom_categories` config option, they will be grouped under 'Other Guides' in the sidebar navigation.\n\nThere are a few limitations:\n- File names must be unique from source files.\n- Readme should be specified separately using the `readme` option.\n\n### Section description abstracts\n\n| Description | Command |\n| ---         | ---     |\n| Command line option | `--abstract={file pattern}` |\n| Example             | `--abstract=Docs/Sections/*.md` |\n| jazzy.yaml example  | `abstract: Docs/Sections/*.md` |\n\nUsing the `--abstract` options, extra markdown can be included after the heading of section overview pages. Think of it as a template include.\n\nThe list of files matching the pattern is compared against the list of sections generated and if a match is found, it's contents will be included in that section before listing source output.\n\nUnlike the `--documentation` option, these files are not included in navigation and if a file does not match a section title, it is not included at all.\n\nThis is very helpful when using `custom_categories` for grouping types and including relevant documentation in those sections.\n\nFor an example of a project using both `--documentation` and `--abstract` see: [https://reswift.github.io/ReSwift/](https://reswift.github.io/ReSwift/)\n\n### Controlling what is documented\n\nIn Swift mode, Jazzy by default documents only `public` and `open` declarations. To\ninclude declarations with a lower access level, set the `--min-acl` flag to `internal`,\n`fileprivate`, or `private`.\n\nIn Objective-C mode, Jazzy documents all declarations found in the `--umbrella-header`\nheader file and any other header files included by it.\n\nYou can control exactly which declarations should be documented using `--exclude`,\n`--include`, or `:nodoc:`.\n\nThe `--include` and `--exclude` flags list source files that should be included/excluded\nrespectively in the documentation. Entries in the list can be absolute pathnames beginning\nwith `/` or relative pathnames. Relative pathnames are interpreted relative to the\ndirectory from where you run `jazzy` or, if the flags are set in the config file, relative\nto the directory containing the config file. Entries in the list can match multiple files\nusing `*` to match any number of characters including `/`.  For example:\n* `jazzy --include=/Users/fred/project/Sources/Secret.swift` -- include a specific file\n* `jazzy --exclude=/*/Internal*` -- exclude all files with names that begin with *Internal*\n  and any files under any directory with a name beginning *Internal*.\n* `jazzy --exclude=Impl1/*,Impl2/*` -- exclude all files under the directories *Impl1* and\n  *Impl2* found in the current directory.\n\nNote that the `--include` option is applied before the `--exclude` option. For example:\n\n* `jazzy --include=/*/Internal* --exclude=Impl1/*,Impl2/*` -- include all files with names\n  that begin with *Internal* and any files under any directory with a name beginning\n  *Internal*, **except** for those under the directories *Impl1* and *Impl2* found in the\n  current directory\n\nDeclarations with a documentation comment containing `:nodoc:` are excluded from the\ndocumentation.\n\n### Documentation structure\n\nBy default Jazzy does not create separate web pages for declarations that do\nnot have any members: instead they are nested into some parent page.  Use the\n`--separate-global-declarations` flag to change this and always create pages\nfor declarations that can be directly accessed from client code.\n\n### Choosing the Swift language version\n\nJazzy normally uses the Swift compiler from the Xcode currently configured by\n`xcode-select`.  Use the `--swift-version` flag to compile with a different\nXcode.\n\nThe value you pass to `--swift-version` must be the Swift language version given\nby `swift --version` in the Xcode you want to use.\n\nFor example to use Xcode 9.4:\n```shell\njazzy --swift-version 4.1.2\n```\n\n## Linux\n\nJazzy uses [SourceKitten][sourcekitten] to communicate with the Swift build\nenvironment and compiler.  The `sourcekitten` binary included in the Jazzy gem\nis built for macOS and so does not run on other operating systems.\n\nTo use Jazzy on Linux you first need to install and build `sourcekitten`\nfollowing instructions from [SourceKitten's GitHub repository][sourcekitten].\n\nThen to generate documentation for a SwiftPM project, instead of running just\n`jazzy` do:\n```shell\nsourcekitten doc --spm \u003e doc.json\njazzy --sourcekitten-sourcefile doc.json\n```\n\nWe hope to improve this process in the future.\n\n## Troubleshooting\n\n### Swift\n\n**Only extensions are listed in the documentation?**\n\nCheck the `--min-acl` setting -- see [above](#controlling-what-is-documented).\n\n**Unable to find an Xcode with swift version X**\n\n1. The value passed with `--swift-version` must exactly match the version\n   number from `swiftc --version`.  For example Xcode 10.1 needs\n   `--swift-version 4.2.1`.  See [the flag documentation](#choosing-the-swift-language-version).\n2. The Xcode you want to use must be in the Spotlight index.  You can check\n   this using `mdfind 'kMDItemCFBundleIdentifier == com.apple.dt.Xcode'`.\n   Some users have reported this issue being fixed by a reboot; `mdutil -E`\n   may also help.  If none of these work then you can set the `DEVELOPER_DIR`\n   environment variable to point to the Xcode you want before running Jazzy\n   without the `--swift-version` flag.\n\n### Installation Problems\n\n**Can't find header files / clang**\n\nSome of the Ruby gems that Jazzy depends on have native C extensions.  This\nmeans you need the Xcode command-line developer tools installed to build\nthem: run `xcode-select --install` to install the tools.\n\n**/Applications/Xcode: No such file or directory**\n\nThe path of your active Xcode installation must not contain spaces.  So\n`/Applications/Xcode.app/` is fine, `/Applications/Xcode-10.2.app/` is fine,\nbut `/Applications/Xcode 10.2.app/` is not.  This restriction applies only\nwhen *installing* Jazzy, not running it.\n\n### MacOS Before 10.14.4\n\nStarting with Jazzy 0.10.0, if you see an error similar to `dyld: Symbol not found: _$s11SubSequenceSlTl` then you need to install the [Swift 5 Runtime Support for Command Line Tools](https://support.apple.com/kb/DL1998).\n\nAlternatively, you can:\n* Update to macOS 10.14.4 or later; or\n* Install Xcode 10.2 or later at `/Applications/Xcode.app`.\n\n## Development\n\nPlease review jazzy's [contributing guidelines](https://github.com/realm/jazzy/blob/master/CONTRIBUTING.md) when submitting pull requests.\n\njazzy is composed of two parts:\n\n1. The parser, [SourceKitten][SourceKitten] (written in Swift)\n2. The site generator (written in ruby)\n\nTo build and run jazzy from source:\n\n1. Install [bundler][bundler].\n2. Run `bundle install` from the root of this repo.\n3. Run jazzy from source by running `bin/jazzy`.\n\nInstructions to build SourceKitten from source can be found at\n[SourceKitten's GitHub repository][SourceKitten].\n\n## Design Goals\n\n- Generate source code docs matching Apple's official reference documentation\n- Support for standard Objective-C and Swift documentation comment syntax\n- Leverage modern HTML templating ([Mustache][mustache])\n- Leverage the power and accuracy of the [Clang AST][ast] and [SourceKit][sourcekit]\n- Support for Dash docsets\n- Support Swift and Objective-C\n\n## License\n\nThis project is released under the [MIT license](https://github.com/realm/jazzy/blob/master/LICENSE).\n\n## About\n\n\u003cimg src=\"images/realm.png\" width=\"184\" /\u003e\n\nJazzy is maintained and funded by Realm Inc. The names and logos for\nRealm are trademarks of Realm Inc.\n\nWe :heart: open source software!\nSee [our other open source projects](https://github.com/realm),\nread [our blog](https://realm.io/news) or say hi on twitter\n([@realm](https://twitter.com/realm)).\n\n[clang]: https://clang.llvm.org \"Clang\"\n[sourcekit]: https://www.jpsim.com/uncovering-sourcekit \"Uncovering SourceKit\"\n[ast]: https://clang.llvm.org/docs/IntroductionToTheClangAST.html \"Introduction To The Clang AST\"\n[xcode]: https://developer.apple.com/xcode \"Xcode\"\n[SourceKitten]: https://github.com/jpsim/SourceKitten \"SourceKitten\"\n[bundler]: https://rubygems.org/gems/bundler\n[mustache]: https://mustache.github.io \"Mustache\"\n[spm]: https://swift.org/package-manager/ \"Swift Package Manager\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsdwebimage%2Fjazzy-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsdwebimage%2Fjazzy-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsdwebimage%2Fjazzy-theme/lists"}