swift-docc

Create DocC catalogs, articles, and tutorials for Swift projects.

1|1|Updated Jan 17, 2026

Search Tags:#documentation #catalog #swift #hosting #tutorials #docc

Ready to run

npx skills add https://github.com/fumiya-kume/toy-poodle-love --skill swift-docc-fumiya-kume

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: swift-docc
Source: https://github.com/fumiya-kume/toy-poodle-love/tree/main/.claude/skills/swift-docc
Command: npx skills add https://github.com/fumiya-kume/toy-poodle-love --skill swift-docc-fumiya-kume

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

DocC-based documentation for Swift projects is often scattered across sources and catalogs; this skill provides a centralized approach to creating DocC catalogs, documenting code, and building tutorials that can be hosted and shared.

Core Features & Use Cases

Create and organize DocC catalogs at Sources/[Target]/Documentation.docc with a canonical landing page.
Generate documentation comments in Swift code (/// and /** */) and write comprehensive articles and interactive tutorials.
Build, preview, and publish DocC outputs to GitHub Pages or CI/CD pipelines using Xcode or SwiftPM.

Quick Start

Create DocC documentation for a Swift project, including a catalog, articles, and tutorials.

Frequently Asked Questions about swift-docc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I create DocC documentation for a Swift project?▼

DocC catalogs are organized at Sources/[Target]/Documentation.docc with a canonical landing page, containing documentation comments, articles, and interactive tutorials for iOS 17+/macOS 14+ targets.

What is the best way to host Swift DocC tutorials on GitHub Pages?▼

The best way to host DocC tutorials is to build and preview DocC outputs, then publish them to GitHub Pages or CI/CD pipelines using Xcode or SwiftPM for automated deployment.

How does DocC catalog structure work for Swift targets?▼

DocC catalog structure works by placing catalogs at Sources/[Target]/Documentation.docc with a canonical landing page, comprehensive articles, and documentation comments in Swift code.

Does Swift DocC support CI/CD pipelines for documentation hosting?▼

Yes, Swift DocC supports CI/CD pipelines by generating a hosting workflow that builds, previews, and publishes DocC outputs to GitHub Pages using Xcode or SwiftPM.

Can I generate interactive tutorials and articles in a DocC catalog?▼

Yes, you can generate interactive tutorials and comprehensive articles within a DocC catalog, alongside writing documentation comments in Swift code using /// and /** */ formats.

What Swift versions are required for building DocC documentation?▼

Building DocC documentation requires iOS 17+ or macOS 14+ targets, using Xcode or SwiftPM to build, preview, and publish the generated DocC outputs.