chore: improve initialise script

Author: maclong9

examples/static/.github/workflows/build.yml

@@ -0,0 +1,67 @@
+name: Build and Deploy Static Site
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: write 
+
+jobs:
+  build:
+    runs-on: macos-15
+    steps:
+      # Check out the repository code
+      - uses: actions/checkout@v4
+      
+      # Set up Swift
+      - name: Setup Swift
+        uses: swift-actions/setup-swift@v2
+      
+      # Cache Swift build artifacts
+      - name: Cache Swift Build
+        uses: actions/cache@v4
+        id: cache-swift-build
+        with:
+          path: .build
+          key: ${{ runner.os }}-swift-build-${{ hashFiles('Package.swift', 'Sources/**') }}
+          restore-keys: |
+            ${{ runner.os }}-swift-build-
+      
+      # Build the project
+      - name: Build
+        run: swift build -v
+        if: steps.cache-swift-build.outputs.cache-hit != 'true'
+      
+      # Cache generated site output
+      - name: Cache Generated Site
+        uses: actions/cache@v4
+        id: cache-site-output
+        with:
+          path: .output
+          key: ${{ runner.os }}-site-output-${{ hashFiles('Sources/**') }}
+          restore-keys: |
+            ${{ runner.os }}-site-output-
+      
+      # Run the static site generator
+      - name: Generate Site
+        run: swift run Application
+        if: steps.cache-site-output.outputs.cache-hit != 'true'
+
+      # Push to static branch (only on push to main)
+      - name: Push to static branch
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+        run: |
+          git config user.name "GitHub Actions Bot"
+          git config user.email "actions@github.com"
+          git checkout -B static
+          rm -rf ./*
+          mv .output/* .
+          rm -rf .output .gitignore .github .build .swift-format
+          git add .
+          git commit -m "release: update static site content"
+          git push origin static --force
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

examples/static/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+.build/
+.output/
+.swiftpm/

examples/static/.swift-format

@@ -0,0 +1,61 @@
+{
+  "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
+  }
+}

examples/static/Package.resolved

@@ -0,0 +1,21 @@
+// swift-tools-version: 6.1
+
+import PackageDescription
+
+let package = Package(
+    name: "Portfolio",
+    platforms: [.macOS(.v15)],
+    dependencies: [
+        .package(url: "https://github.com/maclong9/web-ui.git", from: "1.0.0")
+    ],
+    targets: [
+        .executableTarget(
+            name: "Application",
+            dependencies: [
+                .product(name: "WebUI", package: "web-ui")
+            ],
+            path: "Sources",
+            resources: [.process("Public")]
+        )
+    ]
+)

examples/static/Package.swift

@@ -0,0 +1,36 @@
+import Foundation
+import WebUI
+
+@main
+actor Application {
+    static let metadata = Metadata(
+        site: "example",
+        titleSeperator: " | ",
+        description: "A static website built with Swift and WebUI",
+        image: "https://placehold.co/600x400/EEE/31343C",
+        author: "Swift Developer",
+        keywords: [
+            "swift", "web development", "static site", "webui",
+        ],
+        type: .website,
+        favicons: [
+            .init("https://fav.farm/🖥", type: "image/svg")
+        ],
+    )
+
+    static let routes = [
+        Home().document,
+        About().document,
+    ]
+
+    static func main() async {
+        do {
+            try Website(
+                metadata: metadata,
+                routes: routes,
+            ).build()
+        } catch {
+            print("Failed to build application: \(error)")
+        }
+    }
+}

examples/static/Sources/Application.swift

@@ -0,0 +1,62 @@
+import Foundation
+import WebUI
+
+struct Layout: HTML {
+    let children: Children
+
+    init(@HTMLBuilder children: @escaping HTMLContentBuilder) {
+        self.children = Children(content: children)
+    }
+
+    public func render() -> String {
+        Stack {
+            Header {
+                Link(to: "/") { Application.metadata.site! }
+                    .font(size: .xl2)
+                    .font(size: .xl3, on: .md)
+                    .font(decoration: .underline, on: .hover)
+                Navigation {
+                    for path in Application.routes {
+                        Link(to: "/\(path.path ?? "")") { path.metadata.title ?? "" }
+                            .font(size: .sm)
+                            .font(size: .base, on: .md)
+                            .font(decoration: .underline, on: .hover)
+                    }
+                }.flex(align: .center).spacing(of: 2, along: .x)
+            }
+            .flex(justify: .between, align: .center)
+            .frame(width: .full, maxWidth: .character(86))
+            .margins(at: .bottom)
+            .margins(at: .horizontal, auto: true)
+            .padding(at: .vertical)
+
+            Main {
+                children.render()
+            }
+            .flex(grow: .one)
+            .font(wrapping: .pretty)
+            .frame(maxWidth: .character(72))
+            .margins(at: .horizontal, auto: true)
+
+            Footer {
+                Text {
+                    "© \(Date().formattedYear()) "
+                    Link(to: "/") { Application.metadata.site! }.font(
+                        weight: .normal
+                    )
+                }.font(size: .sm, color: .neutral(._700, opacity: 0.7))
+            }
+            .flex(justify: .center, align: .center)
+        }
+        .font(family: "system-ui")
+        .frame(minHeight: .screen)
+        .flex(direction: .column)
+        .padding()
+        .responsive {
+            $0.md {
+                $0.font(size: .lg)
+            }
+        }
+        .render()
+    }
+}

examples/static/Sources/Components/Layout.swift

@@ -0,0 +1,62 @@
+import WebUI
+
+struct About: HTML {
+    var document: Document {
+        .init(
+            path: "about",
+            metadata: Metadata(
+                title: "About",
+                description: "Learn more about this website and its creator"
+            ),
+            content: { self }
+        )
+    }
+
+    func render() -> String {
+        Layout {
+            Section {
+                Heading(.title) {
+                    "About This Site"
+                }
+                .font(size: .xl3, weight: .bold)
+
+                Text {
+                    "This is the About page of my static website built with WebUI. This page demonstrates how to create multiple pages that share common layout elements but have unique content."
+                }
+
+                Heading(.headline) {
+                    "About the Creator"
+                }
+                .font(size: .xl, weight: .bold)
+
+                Text {
+                    "I'm a Swift developer who loves building clean, fast websites. This site serves as a demonstration of using Swift for web development."
+                }
+
+                Heading(.headline) {
+                    "Built with WebUI"
+                }
+                .font(size: .xl, weight: .bold)
+
+                Text {
+                    "WebUI is a Swift library that makes it easy to build static websites using a component-based approach. Key features include:"
+                }
+
+                List(style: .disc) {
+                    Item { "Type-safe HTML generation" }
+                    Item { "Tailwind-inspired styling API" }
+                    Item { "Component reusability" }
+                    Item { "Simple static site generation" }
+                }.padding()
+
+                Link(to: "/") {
+                    "Return to Home Page"
+                }
+                .background(color: .blue(._500))
+                .font(color: .custom("white"))
+                .padding(EdgeInsets(vertical: 2, horizontal: 4))
+                .rounded(.md)
+            }.spacing(of: 4, along: .y)
+        }.render()
+    }
+}