chore: sync development to main

Author: maclong9

.github/workflows/test.yml

@@ -9,6 +9,7 @@ permissions:
 jobs:
   test:
     runs-on: macos-latest
+    if: ${{ !contains(github.event.head_commit.message, 'docs') }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v4

.swift-format

@@ -1,3 +1,62 @@
 {
-	"lineLength": 180,
+  "indentation" : {
+    "spaces" : 4
+  },
+  "tabWidth" : 4,
+  "fileScopedDeclarationPrivacy" : {
+    "accessLevel" : "private"
+  },
+  "spacesAroundRangeFormationOperators" : false,
+  "indentConditionalCompilationBlocks" : false,
+  "indentSwitchCaseLabels" : false,
+  "lineBreakAroundMultilineExpressionChainComponents" : false,
+  "lineBreakBeforeControlFlowKeywords" : false,
+  "lineBreakBeforeEachArgument" : true,
+  "lineBreakBeforeEachGenericRequirement" : true,
+  "lineLength" : 120,
+  "maximumBlankLines" : 1,
+  "respectsExistingLineBreaks" : true,
+  "prioritizeKeepingFunctionOutputTogether" : true,
+  "rules" : {
+    "AllPublicDeclarationsHaveDocumentation" : false,
+    "AlwaysUseLiteralForEmptyCollectionInit" : false,
+    "AlwaysUseLowerCamelCase" : false,
+    "AmbiguousTrailingClosureOverload" : true,
+    "BeginDocumentationCommentWithOneLineSummary" : false,
+    "DoNotUseSemicolons" : true,
+    "DontRepeatTypeInStaticProperties" : true,
+    "FileScopedDeclarationPrivacy" : true,
+    "FullyIndirectEnum" : true,
+    "GroupNumericLiterals" : true,
+    "IdentifiersMustBeASCII" : true,
+    "NeverForceUnwrap" : false,
+    "NeverUseForceTry" : false,
+    "NeverUseImplicitlyUnwrappedOptionals" : false,
+    "NoAccessLevelOnExtensionDeclaration" : true,
+    "NoAssignmentInExpressions" : true,
+    "NoBlockComments" : true,
+    "NoCasesWithOnlyFallthrough" : true,
+    "NoEmptyTrailingClosureParentheses" : true,
+    "NoLabelsInCasePatterns" : true,
+    "NoLeadingUnderscores" : false,
+    "NoParensAroundConditions" : true,
+    "NoVoidReturnOnFunctionSignature" : true,
+    "OmitExplicitReturns" : true,
+    "OneCasePerLine" : true,
+    "OneVariableDeclarationPerLine" : true,
+    "OnlyOneTrailingClosureArgument" : true,
+    "OrderedImports" : true,
+    "ReplaceForEachWithForLoop" : true,
+    "ReturnVoidInsteadOfEmptyTuple" : true,
+    "UseEarlyExits" : false,
+    "UseExplicitNilCheckInConditions" : false,
+    "UseLetInEveryBoundCaseVariable" : false,
+    "UseShorthandTypeNames" : true,
+    "UseSingleLinePropertyGetter" : false,
+    "UseSynthesizedInitializer" : false,
+    "UseTripleSlashForDocumentationComments" : true,
+    "UseWhereClausesInForLoops" : false,
+    "ValidateDocumentationComments" : false
+  }
 }
+

Package.swift

@@ -3,24 +3,24 @@
 import PackageDescription
 
 let package = Package(
-  name: "web-ui",
-  platforms: [.macOS(.v15), .iOS(.v13), .tvOS(.v13), .watchOS(.v6)],
-  products: [
-    .library(name: "WebUI", targets: ["WebUI"])
-  ],
-  dependencies: [
-    .package(url: "https://github.com/apple/swift-log.git", from: "1.0.0"),
-    .package(url: "https://github.com/apple/swift-markdown", from: "0.6.0"),
-    .package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.4.3"),
-  ],
-  targets: [
-    .target(
-      name: "WebUI",
-      dependencies: [
-        .product(name: "Logging", package: "swift-log"),
-        .product(name: "Markdown", package: "swift-markdown"),
-      ]
-    ),
-    .testTarget(name: "WebUITests", dependencies: ["WebUI"]),
-  ]
+    name: "web-ui",
+    platforms: [.macOS(.v15), .iOS(.v13), .tvOS(.v13), .watchOS(.v6)],
+    products: [
+        .library(name: "WebUI", targets: ["WebUI"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/apple/swift-log.git", from: "1.0.0"),
+        .package(url: "https://github.com/apple/swift-markdown", from: "0.6.0"),
+        .package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.4.3"),
+    ],
+    targets: [
+        .target(
+            name: "WebUI",
+            dependencies: [
+                .product(name: "Logging", package: "swift-log"),
+                .product(name: "Markdown", package: "swift-markdown"),
+            ]
+        ),
+        .testTarget(name: "WebUITests", dependencies: ["WebUI"]),
+    ]
 )

README.md

@@ -94,59 +94,11 @@ And then add this to your Target:
 
 Comprehensive API documentation is available on the [GitHub Pages](https://maclong9.github.io/web-ui/documentation/webui/).
 
-### Tutorials
+#### Learning Resources
 
-- [Creating a Static Site](https://maclong9.github.io/web-ui/tutorials/webui/creating-a-static-site)
 - [Getting Started with WebUI](https://maclong9.github.io/web-ui/documentation/webui/getting-started)
-
-### Examples
-
-- [Portfolio](https://github.com/maclong9/portfolio) - A personal portfolio website built with WebUI
-
-### Adding WebUI to a Swift Package Manager (SPM) project
-
-To add WebUI to your Swift project using the Swift Package Manager, follow these
-steps:
-
-1. Open your `Package.swift` file.
-2. Add the WebUI repository URL to the `dependencies` array.
-  - Select `from: "x.x.x"` for the release version.
-  - Select `from: "next-x.x.x"` for the pre-release version.
--  Select `branch: "development"` for the most up to date changes.
-
-```swift
-dependencies: [
-    .package(url: "https://github.com/maclong9/web-ui.git", from: "1.0.0") // Release Version
-    .package(url: "https://github.com/maclong9/web-ui.git", from: "next-1.1.0") // Pre-Release Version
-    .package(url: "https://github.com/maclong9/web-ui.git", branch: "development") // Development Version
-],
-```
-
-3. Include `WebUI` as a dependency for your target(s):
-
-```swift
-targets: [
-    .target(
-        name: "YourTargetName",
-        dependencies: [
-            .product(name: "WebUI", package: "web-ui")
-        ]
-    ),
-]
-```
-
-4. Save the `Package.swift` file and run the following command in your terminal
-   to fetch the dependencies:
-
-```sh
-swift package update
-```
-
-5. You can now import and use WebUI in your project files:
-
-```swift
-import WebUI
-```
+- [Creating a Static Site](https://maclong9.github.io/web-ui/tutorials/webui/creating-a-static-site)
+- [Portfolio Example](https://github.com/maclong9/portfolio) - A personal portfolio website built with WebUI
 
 ## Development