swift-doc
swift-doc copied to clipboard
SwiftDocOrg
A documentation generator for Swift projects
If a type has conformances defined both in the main type declaration and in extensions, `swift-doc` only shows the ones defined directly in type in the docs declaration. For example,...
In my project, I use a an `enum` as namespacing and nest all my types inside it. The main page looks like this: https://sindresorhus.com/playground/ However, I would like to make...
For https://github.com/sindresorhus/KeyboardShortcuts/blob/49b017b2450ac37353934d94d6c64957b62c45b4/Sources/KeyboardShortcuts/Key.swift#L8-L34, I get the following: https://sindresorhus.com/playground/KeyboardShortcuts_Key/ With Jazzy, I get the enum cases grouped too: https://sindresorhus.com/KeyboardShortcuts/Classes/KeyboardShortcuts/Key.html#/Letters
As an author of the frameworks which work on multiple platforms and have slightly different APIs for each one, I would like to be able to generate different sets of...
As we begin to add (#65) and consider (#57, #72) new options for the `generate` command, I think it's likely that the number of options for the `generate` command will...
Expanding on what's currently in the README, we should provide a step-by-step tutorial to help onboard new users.
The [Service Worker API](https://developer.mozilla.org/en/docs/Web/API/Service_Worker_API) allows webpages to download, install, and activate resources that can later be used by the browser. This allows users to view webpages when they're not connected...
> Here be dragons 🐲 In an effort to get everything out the door, I kind of took a "whatever works" approach to development. To that end, [HyperTextLiteral](https://github.com/NSHipster/HypertextLiteral) was great...
In the original README, there was a [Motivation section](https://github.com/SwiftDocOrg/swift-doc/tree/b5274fbe4813dc6e6616007009747979315e2cfc#motivation) that included a list of the project's dependencies, like [SwiftSemantics](https://github.com/SwiftDocOrg/SwiftSemantics). We should bring back and revise this for the next release.
As mentioned in #39, the README used to have a ["Motivation" section](https://github.com/SwiftDocOrg/swift-doc/tree/b5274fbe4813dc6e6616007009747979315e2cfc#motivation) that discussed how `swift-doc` compared to Jazzy. I removed that for the first beta, because a lot of...
Metadata
Owner
Metadata
A documentation generator for Swift projects