skills.rest
r1cA18
r1cA18COMMUNITY
Explore all skills by this author →
GitHub

docc

Generate and preview Swift project documentation with the DocC framework.

4|Updated Nov 22, 2025
Search Tags:#developer tools#documentation#swift#xcode#tutorial#docc
One-click install
npx skills add https://github.com/r1cA18/dotfiles --skill docc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docc
Source: https://github.com/r1cA18/dotfiles/tree/main/skills/swift-dev-toolkit/skills/docc
Command: npx skills add https://github.com/r1cA18/dotfiles --skill docc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill simplifies the creation and previewing of documentation for Swift projects using Apple's DocC framework, making it easier to share your work.

Core Features & Use Cases

  • Documentation Generation: Build documentation for standalone Swift projects or those embedded within Xcode projects.
  • Live Preview: Preview your documentation locally before publishing.
  • Use Case: You've just finished a new Swift framework and want to create a user-friendly guide with tutorials. Use this Skill to generate and preview the documentation.

Quick Start

Use the docc skill to preview the documentation at Documentation.docc on port 8080.

Frequently Asked Questions about docc

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

FAQPage Schema
How do I generate DocC documentation for a Swift project?▼

DocC documentation for Swift projects is generated by building API references and tutorials using the DocC framework. This Skill supports both standalone Swift projects and Xcode-embedded projects to create user-friendly guides.

Can I live preview Swift tutorials and documentation locally?▼

You can live preview Swift tutorials and documentation locally using the xcrun docc command. This Skill enables local previewing of your Documentation.docc files on a specified port before publishing.

Do I need Xcode to build documentation for standalone Swift projects?▼

Xcode is not required for standalone Swift projects, but xcodebuild is necessary for building documentation within Xcode-embedded projects. This Skill supports both standalone generation and Xcode-embedded workflows.

What is the best way to create a tutorial for a new Swift framework?▼

Creating a tutorial for a new Swift framework is best achieved using Apple's DocC framework. This Skill simplifies the process by generating and previewing interactive tutorials and API references directly from your Swift code.

Does this DocC generator work with Xcode-embedded projects?▼

This DocC generator works with Xcode-embedded projects by utilizing xcodebuild to build the documentation. It supports both standalone Swift packages and projects integrated within an Xcode workspace.

Related Skills

Explore More Software Engineering Skills→
involvexinvolvex
2

capacitor-plugin-spm-support

Generate a Package.swift and migrate Objective-C bridge code to CAPBridgedPlugin.

Community
Advanced
fumiya-kumefumiya-kume
1

swift-docc

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

Community
Advanced
ldomaradzkildomaradzki
459

formatting-build-output

Format xcodebuild and swift build output into TOON format.

Community
Advanced
luongnv89luongnv89
40.9k

api-documentation-generator

Generate API documentation from source code into Markdown and OpenAPI-style specs.

Community
Basic