Skip to content
Documentation Generation for Swift Projects
Swift CSS Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
SwiftyDocs.xcodeproj
SwiftyDocs
SwiftyDocsTests
assets/icon_design
.gitignore
Cartfile.resolved
README.md
TODO.md
cartfile

README.md

SwiftyDocs

I wanted to generate some documentation for my Swift projects, but wasn't satisfied with the available tools. Here's what I came up with!

If you like it, it would be wonderful if you would purchase a compiled copy. Even if you just download and build it yourself, it would show appreciation for my work in developing this. If you're strapped for cash, unsatisfied with the product, or just otherwise just don't want to, that's fine too. You are welcome to download a copy of the source and build it yourself at no charge.

If you have any ideas or enhancements you'd like to contribute, please make a pull request.

Instructions

screenshot

  1. Simply open an Xcode project written in Swift (there's no reason it shouldn't be able to work in any other language support by Xcode, but only Swift has been tested/supported officially)
  2. Rename the project if desired. This will change the title of the documentation when exporting.
  3. Select the minimum access level that should be accounted for during export.
  4. The exported items popup will display the resulting selection. This is a read only output.
  5. Determine if you want a single page of documentation or a separate page for each entity accessible on the global namespace.
  6. Determine if you want raw markdown output, a folder of HTML for easy hosting wherever, or a Dash docset (note that the Dash docset inherently requires a single file of output).
  7. Hit export and save your documentation!
You can’t perform that action at this time.