![]() Let's begin by evaluating the current state of its documentation. I've opened the SlothCreator Swift package in Xcode 15. We want SlothCreator to be used in more iOS apps so we've been looking at ways we can improve its documentation. SlothCreator is a framework that can be imported into iOS apps and used to catalog, customize, and display little sloths. Over the last couple of years, my teammates and I have been working on a Swift package called SlothCreator. Finally, after publishing the documentation to the web, we'll take a tour of the brand new navigation capabilities coming to all Swift-DocC websites with Xcode 15. Next, we'll create a custom theme for the documentation so that the web version looks right at home with an existing website. We'll use the new editor as we take advantage of some new Swift-DocC capabilities to enhance the existing documentation for a framework. We'll begin today by covering a new workflow for writing documentation with Xcode 15's Documentation Preview editor. These two sessions introduce the framework that we'll be improving the documentation for today and guide you through the process of adding your first pieces of documentation to a brand-new project. So if this is your first time learning about Swift-DocC, I’d recommend first watching "Meet DocC documentation in Xcode" and "Elevate your DocC documentation in Xcode". This session will focus on some more advanced capabilities of Swift-DocC. And with brand-new authoring capabilities like grid-based layouts, video support, custom page icons, and even fully custom themes, you can craft truly bespoke documentation that really advocates for your project. The Documentation Preview editor gives you a real-time view of the rendered version of your documentation as you type, providing feedback with every keystroke. Xcode 15 brings the experience of writing Swift-DocC documentation to a whole new level. We've worked with the Swift community to add support for documenting all of your projects, including support for both apps and frameworks whether written in Swift, Objective-C, or even a mix of the two. Since the release of Swift-DocC in Xcode 13, the Swift-DocC project has been open sourced and is now developed in the open. This means that the documentation you write will be automatically available to anyone who has access to your source code, without any additional work on your end. And of course, your documentation will also appear in Xcode's built-in documentation window and integrate into Xcode's Source editor with Quick Help. This documentation is compatible out-of-the-box with static web hosting solutions, allowing straightforward publishing to services like GitHub Pages and Netlify. You use a mix of documentation comments written directly in-source and standalone Markdown files to write both high-level conceptual content and detailed technical documentation. Swift-DocC is a documentation compiler integrated directly into Xcode that allows you to write and publish rich documentation for your project right alongside your source code. Let's start with a quick overview of Swift-DocC. And with Xcode 15's brand new Documentation Preview editor, you'll be able to iterate on your documentation without ever leaving the Source editor. Xcode 15 brings all new capabilities to your Swift-DocC documentation that will not only make your documentation stand out, but also give you more effective tools for teaching your reader about your app or framework. I'm Ethan, an engineer on the Swift-DocC team. ♪ ♪ Ethan: Hello! And welcome to "Create rich documentation with Swift-DocC". Search the forums for tag wwdc2023-10244. ![]() Have a question? Ask with tag wwdc2023-10244.28:29 - Publishing and browsing documentation on the web.25:12 - Theming the online version of your documentation.13:53 - Using Swift-DocC directives to create rich documentation pages.12:06 - Organizing documentation pages into Topic Groups.9:44 - Adding an image to your documentation.8:05 - Activating the Documentation Preview editor.3:33 - Building and browsing documentation in Xcode.0:00 - Introduction and overview of Swift-DocC.To get the most out of this session, you should have a working knowledge of the basics of Swift-DocC documentation. We'll show you how to use the Xcode 15 Documentation Preview editor to efficiently iterate on your existing project's documentation, and explore expanded authoring capabilities like grid-based layouts, video support, and custom themes. Learn how you can take advantage of the latest features in Swift-DocC to create rich and detailed documentation for your app or framework. Create rich documentation with Swift-DocC.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |