swiftontap/docs

Complete SwiftUI Docs with Examples

🍻 SwiftOnTap

Complete SwiftUI Docs with Examples.

Get Started | How It Works | Add Docs

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. 🚰🍻

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 🚴

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!

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!

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.

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!

docs's Issues

Great work!!!!

Post-shutdown: build instructions?

I can't find any hints on what tool is used from the web archives. There are no leads in the Github workflow either:

https://github.com/SwiftOnTap/Docs/blob/a6eec52ae9f85ee59265e6566bcb84f53ac6b729/.github/workflows/deploy-prod.yml#L24C1-L27C76

The existing tools are:

• DocC, which seems to only supports packages and frameworks (the documentation is ironically worse than for SwiftUI)
• Swift-Doc, which is abandoned, the repo archived recently. The brew formula fails to build (seems like they used a private symbol), and I don't think its worth the effort to debug.

The only solution I can think of is creating a dummy package from which the documentation can be generated with DocC. This is working against the tools though, and I would like to avoid this.

Has anyone found a solution to build the documentation since https://SwiftOnTap.com shut down?

https://swiftontap.com is down?

What happened to the website? How can I run the documentation locally if the website isn't working?

RotationGesture code example should be ContentView

The RotationGesture symbol code example uses RotationGestureView (see https://swiftontap.com/rotationgesture)

This should be updated to ContentView to be thematically consistent with other pages.

The relationship between the website and SwiftUI.swift main file is confusing

TL;DR

I would like to contribute, but I am not sure how exactly the SwiftUI.swift translates into the website.

In the SwiftUI.swift file, it seems like there is an extension for every single existing Swift API, with copied paste documentation from Apple's Documentation. Obviously, the point of this project is to replace them with better, detailed, step by step documentation. But not all the methods in SwiftUI.swift shows up on the website. Will they automatically show up once the documentation is edited, or is this a manual process?

By the way, should we break up the SwiftUI.swift file into subfiles, organizing by the SwiftUI component type? Because it is kind of painful when all the previews on Github doesn't work.

Very nice documentation, but expected to add MacOS support.

On macOS, some SwiftUI controls are displayed differently, and there are also some controls that can only be used on their respective platforms on macOS and iOS. I hope they can be more comprehensively reflected in the document.

such as:

#if os(macOS)
Settings {
Text("Settings here.")
}
#endif

English is not my native language; please excuse typing errors.

Dark Mode

Hi

I am iOS developer and I saw swiftontap.com new.
Its a great documentation tool and helped me a lot.
Thank you very much for your works.

Also I have suggestion to add Dark Mode support on https://swiftontap.com
Many developers use the dark mode and it is very difficult to focus on a light background.
Thanks