Swift DocC: How to Host Document Archive on Web Server and GitHub Pages

#Swift #Documentation #DocC #iOS #macOS #Xcode
https://www.appcoda.com/swift-docc/

TIL #Swift #DocC has a way to generate diagrams like these with a plugin called #SymbolKit <3 https://apple.github.io/swift-docc-symbolkit/documentation/symbolkit/

Free idea for someone:

Take the SwiftDocC .docarchive and convert it into an ePub so we can have documentation in eBook format.

I’d do it but I’m full up on projects.

#swift #programming #DocC #epub #books

Using Shift+Cmd+O in Xcode? 🙋

You can now use the same shortcut to search & open specific documentation on the Apple Developer website! 🤯🚀

Discovered this incredible #DocC feature in below #WWDC23 session & tested it online – it works! 🤩

Full notes:
https://wwdcnotes.com/notes/wwdc23/10244/

#DocC is awesome. I’m surprised more people haven’t been talking about it since it was introduced at #WWDC21. I have tried similar systems in the past, like Doxygen, but they have been too much work and diverged too far from my workflow. DocC fits in perfectly with my style of coding and feels like almost no work. It’s even fun sometimes.
#Swift #Xcode #Markdown

Ok I was NOT supposed to spend any more time on this, but I nerdsniped myself by starting looking into it.

Got very basic binding generation working between #GodotEngine and #Swift

Adding the docs too, so I should be able to generate a #docc website afterwards.

@krzyzanowskim @amyworrall Static site generation by #DocC itself. It's not great, but works well enough. Don't have much time at hand to improve docc2html.

It took a while, but #DocC extension support is finally ready for you to try! Check out my post on the #Swift Forums for instructions and more: https://forums.swift.org/t/enablement-of-docc-extension-support-as-an-opt-in-feature/62614. Thanks to everyone who helped me make it happen!

#LunchBreakFOSS It isn’t obviously a FOSS project but it actually is all #ServerSideSwift and OpenSource on GitHub! The “Swift Package Index” for #SwiftLang by @finestructure and @daveverwer.
The recent feature I like the most is the builtin hosting of #DocC documentation.
https://swiftpackageindex.com

#LunchBreakFOSS It isn’t obviously a FOSS project but it actually is all #ServerSideSwift and OpenSource on GitHub! The “Swift Package Index” for #SwiftLang by @finestructure and @daveverwer.
The recent feature I like the most is the builtin hosting of #DocC documentation.
https://swiftpackageindex.com

#LunchBreakFOSS “Lighter” is my most recent (opensource) project and I really like it. It is fed with #SQLite SQL code or even databases and generates #SwiftLang code to access the database (optionally w/o extra lib deps!). Beautifully annotated with #DocC comments, i.e. you can actually browse the database/Swift documentation within Xcode. Can be used to ship SQLite DB resources alongside your app for static data, for offline caches, on #ServerSideSwift, …
https://lighter-swift.github.io/documentation/lighter

#LunchBreakFOSS “Lighter” is my most recent (opensource) project and I really like it. It is fed with #SQLite SQL code or even databases and generates #SwiftLang code to access the database (optionally w/o extra lib deps!). Beautifully annotated with #DocC comments, i.e. you can actually browse the database/Swift documentation within Xcode. Can be used to ship SQLite DB resources alongside your app for static data, for offline caches, on #ServerSideSwift, …
https://lighter-swift.github.io/documentation/lighter

#LunchBreakFOSS “DocZ” is a Swift package to read #DocC (the “new” language integrated Apple documentation system for #SwiftLang) archives and to process them. It even includes a basic static exporter (docc2html) and a single-file #ServerSideSwift Macro server for DocC catalogs.

Wrote this because originally DocC itself didn’t support static site exports (and honestly, the current one is still isn't exactly great).
https://github.com/DoccZz/docc2html

#LunchBreakFOSS “DocZ” is a Swift package to read #DocC (the “new” language integrated Apple documentation system for #SwiftLang) archives and to process them. It even includes a basic static exporter (docc2html) and a single-file #ServerSideSwift Macro server for DocC catalogs.

Wrote this because originally DocC itself didn’t support static site exports (and honestly, the current one is still isn't exactly great).
https://github.com/DoccZz/docc2html

Oof I think it is not possible to make inter module links in #swift #DocC I was hoping I can create a top level documentation in the project with a landing page describes the overall architecture with links to symbols in feature modules and domain modules defined under the project. But I guess docc documentations are strictly associated with frameworks & spm modules :(

Anyone got experience using #DoCC for #ObjectiveC projects? See my question on StackOverflow: https://stackoverflow.com/questions/74263875/using-docc-for-an-objective-c-project

Mañana hablamos de #DocC y #Swift en la NSCoder Night de Madrid!

Apúntate! https://www.meetup.com/nscoder-night-madrid/events/289541898/

Este Miércoles, hablaré de #DocC y #Swift en la #NSCoderNight Madrid. Vente y lo vemos juntos!

https://www.meetup.com/nscoder-night-madrid/events/289541898/

Host and Automate your DocC documentation

#Swift #DocC #Xcode
https://medium.com/kinandcartacreated/host-and-automate-your-docc-documentation-c6ac29dc0feb

@krzyzanowskim @bonk Very nice! One advantage of CodeEditor is that it uses Highlight.js, which comes with a ton of supported languages.
BTW: Team #DocC, please enable SQL highlighting in your implementation!