Skip to content

livingston/apple-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Apple Documentation (Offline)

Offline mirror of Apple's developer documentation as markdown files, for use with neuledge/context or any tool that consumes markdown docs.

Frameworks Included

Core: Swift, Foundation, Combine, Observation UI: SwiftUI, UIKit, AppKit Data: SwiftData, CoreData Networking: Network, WebKit Media: AVFoundation, PhotoKit System: CoreLocation, MapKit, CoreBluetooth Services: CloudKit, StoreKit, UserNotifications, WidgetKit, ActivityKit, AppIntents ML/AI: CoreML, Vision, NaturalLanguage, CreateML, FoundationModels Graphics: Metal, SpriteKit, SceneKit, RealityKit Security: Security, CryptoKit Developer Tools: Xcode, Testing

Usage with context

context add ./documentation --name apple-docs

Updating the docs

cd scripts

# Re-scrape everything (skips existing files)
uv run main.py

# Force re-download
uv run main.py --force

# Specific frameworks at custom depth
uv run main.py --frameworks swiftui foundationmodels --depth 4

# Post-process: fix links + download images
uv run postprocess.py

Scraper options

Flag Default Description
--frameworks all Space-separated framework names
--output ../documentation Output directory
--depth 2 Max crawl depth (0=framework only)
--concurrency 5 Concurrent requests
--delay 0.1 Delay between requests (seconds)
--force off Re-download existing files

Post-process options

Flag Default Description
--skip-images off Skip image downloads
--dry-run off Show stats without modifying
--concurrency 10 Image download concurrency

Source

All documentation is fetched from Apple's public markdown endpoint:

https://developer.apple.com/tutorials/data/documentation/{path}.md

License

Documentation content is Copyright Apple Inc. This repo is a tooling wrapper for personal/offline use.

About

Offline mirror of Apple's developer documentation as markdown files

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages