Docs

.swiftlint.yml

@@ -0,0 +1,6 @@
+disabled_rules:
+  - nesting
+  - file_length
+  - function_body_length
+  - type_body_length
+  - large_tuple

Package.resolved

@@ -0,0 +1,24 @@
+{
+  "originHash" : "ed31ca32dc2eaeeeac6cd0423ed78fa0a352bf7bc51e7550faa3ce07ce4c0d40",
+  "pins" : [
+    {
+      "identity" : "swift-docc-plugin",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/apple/swift-docc-plugin",
+      "state" : {
+        "revision" : "85e4bb4e1cd62cec64a4b8e769dcefdf0c5b9d64",
+        "version" : "1.4.3"
+      }
+    },
+    {
+      "identity" : "swift-docc-symbolkit",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/swiftlang/swift-docc-symbolkit",
+      "state" : {
+        "revision" : "b45d1f2ed151d057b54504d653e0da5552844e34",
+        "version" : "1.0.0"
+      }
+    }
+  ],
+  "version" : 3
+}

Package.swift

@@ -1,5 +1,5 @@
 // swift-tools-version: 5.10
-// The swift-tools-version declares the minimum version of Swift required to build this package.
+// the swift-tools-version declares the minimum version of Swift required to build this package
 
 import PackageDescription
 
@@ -9,15 +9,18 @@ let package = Package(
         .macOS(.v13)
     ],
     products: [
-        // Products define the executables and libraries a package produces, making them visible to other packages.
+        // products define the executables and libraries a package produces, making them visible to other packages
         .library(
             name: "Luminare",
             targets: ["Luminare"]
         )
     ],
+    dependencies: [
+        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0")
+    ],
     targets: [
-        // Targets are the basic building blocks of a package, defining a module or a test suite.
-        // Targets can depend on other targets in this package and products from dependencies.
+        // targets are the basic building blocks of a package, defining a module or a test suite
+        // targets can depend on other targets in this package and products from dependencies
         .target(
             name: "Luminare"
         ),

Sources/Luminare/Utilities/LuminareBackgroundEffect.swift → Sources/Luminare/Components/Auxiliary/LuminareBackgroundEffect.swift

@@ -7,6 +7,7 @@
 
 import SwiftUI
 
+/// A background effect that matches ``Luminare``.
 public struct LuminareBackgroundEffect: ViewModifier {
     public func body(content: Content) -> some View {
         content
@@ -17,9 +18,3 @@ public struct LuminareBackgroundEffect: ViewModifier {
             }
     }
 }
-
-public extension View {
-    func luminareBackground() -> some View {
-        modifier(LuminareBackgroundEffect())
-    }
-}