Markdown generator for IOS SDKs

[AnnaWinnick]

I currently maintain an iOS SDK and use jazzy to generate HTML documentation. I'm now looking for a tool or plugin that can generate markdown documentation compatible with Docusaurus. The SDK involves both Objective-C and Swift files, so I need a tool that can handle parsing both languages effectively.

I've tried using sourcedoc, which works well for a Swift-only SDK, but it doesn’t fully meet our needs for the ClientSDK, which is primarily implemented in Objective-C. Additionally, we need a way to avoid exposing certain internal APIs that are marked as public in the generated documentation.

Would love to hear what tools others are using 😄

[slorber]

That looks like a quite specific need.
Unfortunately, we can't really solve this officially in core and usually rely on our community to provide plugins for these use cases. I don't remember seeing any community member working on these things so far.

---

Related to a broader issue: #1059

If you already use Jazzy, and it works well for you, why do you need to use Docusaurus and Markdown? My assumption is that you want to co-locate SDK reference API docs with guides, tutorials and other pages in a single site.

The easiest possibility would be to "embed" the HTML output of Jazzy inside a Docusaurus site layout through iframes, would it work for your use-case?

[AnnaWinnick]

Hi @slorber - I appreciate the suggestion. Your assumption is correct. We have a public site up that devs are publishing APIs and guides on for our customers. However, the jazzy docs UX differs too much from the one we have created with Docusaurus. Embedding is one option, but feels too visually disruptive with the output of this specific tool.

We are toying with the idea of getting rid of objC and using just Swift + sourcedoc.

I'd like to keep the post up in case anyone stumbles across it with a tool suggestion but we have options to explore.