Home

Awesome

<h1 align="center">🍻 SwiftOnTap</h1> <h3 align="center"> Complete SwiftUI Docs with Examples. </h3> <p align="center"> <strong><a href="#get-started">Get Started</a></strong> | <strong><a href="#how-it-works">How It Works</a></strong> | <strong><a href="#add-docs">Add Docs</a></strong> </p> <br/>

Get Started

To get started,

  1. Go to swiftontap.com 👉.
  2. Press / and search for a struct, enum, func, or any other SwiftUI symbol.
  3. Press return.

We've got it all on tap. 🚰🍻

<br/>

If you're new to SwiftUI 🤓

We get it, docs are overwhelming at first. To start, we recommend these resources (in order!)

  1. Apple's Swift book (if you're new to the language)
  2. Apple's SwiftUI tutorials, which are quite good!
  3. SwiftOnTap (these docs) once you get moving 🚴
<br/>

How It Works

Who wrote all these docs?

A bunch of us SwiftUI developers have been hard at work filling Apple's documentation hole 🕳. You can also edit these docs!

<br/>

Where do the docs live?

All the docs live in one file called SwiftUI.swift. It's just a regular .swift file with lots of documentation comments 🧑‍💻. Whenever anyone edits this file on GitHub, we automatically scan for the comments. Then it goes live to swiftontap.com!

<br/>

Could this work for any .swift file?

Theoretically, yes! We've just been focused writing SwiftUI docs for now. Let us know 📧 if you want to generate your own sweet documentation site.

<br/>

Add Docs

To add or edit docs,

  1. Open a pull request from github.com/SwiftOnTap/Docs. (See here to learn how!)
  2. See this Apple guide for writing great documentation comments.
  3. Sit back 🧘, and watch your work go live!