ci: replace Jazzy documentation with DocC (#38)

quver · web-flow · commit 40186280ee55 · 2026-03-14T03:04:36.000+01:00
diff --git a/.github/workflows/PublishDocumentation.yml b/.github/workflows/PublishDocumentation.yml
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,53 @@
+name: Documentation
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+env:
+  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
+
+jobs:
+  build:
+    name: Build Documentation
+    runs-on: macos-15
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
+      - name: Build DocC documentation
+        run: |
+          swift package \
+            --allow-writing-to-directory ./docs \
+            generate-documentation \
+            --target SlidableImage \
+            --output-path ./docs \
+            --transform-for-static-hosting \
+            --hosting-base-path SlidableImage
+      - name: Add root redirect
+        run: |
+          echo '<html><head><meta http-equiv="refresh" content="0; url=/SlidableImage/documentation/slidableimage/"></head></html>' > ./docs/index.html
+      - uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
+        with:
+          path: ./docs
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy
+        id: deployment
+        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5
diff --git a/Package.swift b/Package.swift
@@ -14,8 +14,10 @@ let package = Package(
             targets: ["SlidableImage"]
         )
     ],
+    dependencies: [
+        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.3.0"),
+    ],
     targets: [
         .target(name: "SlidableImage"),
-
     ]
 )

Original file line number	Diff line number	Diff line change
`@@ -14,8 +14,10 @@ let package = Package(`
`14`	`14`	`targets: ["SlidableImage"]`
`15`	`15`	`)`
`16`	`16`	`],`
	`17`	`+ dependencies: [`
	`18`	`+ .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.3.0"),`
	`19`	`+ ],`
`17`	`20`	`targets: [`
`18`	`21`	`.target(name: "SlidableImage"),`
`19`		`-`
`20`	`22`	`]`
`21`	`23`	`)`