Skip to content

armgit / xtool

Public Imported from GitHub
0

Cross-platform Xcode replacement. Build and deploy iOS apps with SwiftPM on Linux, Windows, macOS.

GitHub Pages (#56)

Kabir Oberaidfb0e36d0e43
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 0000000..a3444b6
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,29 @@
+on:
+ push:
+ branches:
+ - main
+permissions:
+ contents: read
+ pages: write
+ id-token: write
+jobs:
+ deploy:
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+ runs-on: macos-15
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+ - name: Setup Pages
+ uses: actions/configure-pages@v5
+ - name: Build DocC
+ run: |
+ ./scripts/build-docs.sh
+ - name: Upload artifact
+ uses: actions/upload-pages-artifact@v3
+ with:
+ path: 'docs'
+ - id: deployment
+ name: Deploy to GitHub Pages
+ uses: actions/deploy-pages@v4
diff --git a/.gitignore b/.gitignore
index 590a95c..05120c3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -12,3 +12,4 @@ DerivedData/
.docc-build
/openapi
+/docs
diff --git a/Package.swift b/Package.swift
index 8237c1a..b83ca5e 100644
--- a/Package.swift
+++ b/Package.swift
@@ -161,5 +161,8 @@ let package = Package(
],
cSettings: cSettings
),
+ .executableTarget(
+ name: "XToolDocs"
+ ),
]
)
diff --git a/README.md b/README.md
index 70460a3..60b9f83 100644
--- a/README.md
+++ b/README.md
@@ -15,9 +15,9 @@ xtool is a cross-platform (Linux/WSL/macOS) tool that replicates Xcode functiona
## Getting Started
1. Follow the guide to install `xtool`
- - [Installation (Linux/Windows)](https://swiftpackageindex.com/xtool-org/xtool/documentation/xtool/installation-linux)
- - [Installation (macOS)](https://swiftpackageindex.com/xtool-org/xtool/documentation/xtool/installation-macos)
-2. Create and run your first xtool-powered app by following the [tutorial](https://swiftpackageindex.com/xtool-org/xtool/tutorials/xtool/first-app)!
+ - [Installation (Linux/Windows)](https://xtool.sh/documentation/xtooldocs/installation-linux)
+ - [Installation (macOS)](https://xtool.sh/documentation/xtooldocs/installation-macos)
+2. Create and run your first xtool-powered app by following the [tutorial](https://xtool.sh/tutorials/xtooldocs/first-app)!
## Examples
diff --git a/Sources/xtool/Documentation.docc/Control.md b/Sources/XToolDocs/Documentation.docc/Control.md
similarity index 100%
rename from Sources/xtool/Documentation.docc/Control.md
rename to Sources/XToolDocs/Documentation.docc/Control.md
diff --git a/Sources/xtool/Documentation.docc/Documentation.md b/Sources/XToolDocs/Documentation.docc/Documentation.md
similarity index 81%
rename from Sources/xtool/Documentation.docc/Documentation.md
rename to Sources/XToolDocs/Documentation.docc/Documentation.md
index 7556e78..dd3c15f 100644
--- a/Sources/xtool/Documentation.docc/Documentation.md
+++ b/Sources/XToolDocs/Documentation.docc/Documentation.md
@@ -1,9 +1,15 @@
-# ``xtool``
+# ``XToolDocs``
+
+@Metadata {
+ @DisplayName("xtool")
+}
Cross-platform Xcode replacement.
## Overview
+[View on GitHub](https://github.com/xtool-org/xtool)
+
xtool is a cross-platform (Linux/WSL/macOS) tool that replicates Xcode functionality with open standards.
✅ Build a SwiftPM package into an iOS app
diff --git a/Sources/xtool/Documentation.docc/First-app-code/build-1a.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/build-1a.sh
similarity index 100%
rename from Sources/xtool/Documentation.docc/First-app-code/build-1a.sh
rename to Sources/XToolDocs/Documentation.docc/First-app-code/build-1a.sh
diff --git a/Sources/xtool/Documentation.docc/First-app-code/build-1b.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/build-1b.sh
similarity index 100%
rename from Sources/xtool/Documentation.docc/First-app-code/build-1b.sh
rename to Sources/XToolDocs/Documentation.docc/First-app-code/build-1b.sh
diff --git a/Sources/xtool/Documentation.docc/First-app-code/build-2.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/build-2.sh
similarity index 100%
rename from Sources/xtool/Documentation.docc/First-app-code/build-2.sh
rename to Sources/XToolDocs/Documentation.docc/First-app-code/build-2.sh
diff --git a/Sources/xtool/Documentation.docc/First-app-code/build-3.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/build-3.sh
similarity index 100%
rename from Sources/xtool/Documentation.docc/First-app-code/build-3.sh
rename to Sources/XToolDocs/Documentation.docc/First-app-code/build-3.sh
diff --git a/Sources/xtool/Documentation.docc/First-app-code/edit-2.swift b/Sources/XToolDocs/Documentation.docc/First-app-code/edit-2.swift
similarity index 100%
rename from Sources/xtool/Documentation.docc/First-app-code/edit-2.swift
rename to Sources/XToolDocs/Documentation.docc/First-app-code/edit-2.swift
diff --git a/Sources/xtool/Documentation.docc/First-app-code/edit-4.swift b/Sources/XToolDocs/Documentation.docc/First-app-code/edit-4.swift
similarity index 100%
rename from Sources/xtool/Documentation.docc/First-app-code/edit-4.swift
rename to Sources/XToolDocs/Documentation.docc/First-app-code/edit-4.swift
diff --git a/Sources/xtool/Documentation.docc/First-app-code/rerun-5a.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/rerun-5a.sh
similarity index 100%
rename from Sources/xtool/Documentation.docc/First-app-code/rerun-5a.sh
rename to Sources/XToolDocs/Documentation.docc/First-app-code/rerun-5a.sh
diff --git a/Sources/xtool/Documentation.docc/First-app-code/rerun-5b.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/rerun-5b.sh
similarity index 100%
rename from Sources/xtool/Documentation.docc/First-app-code/rerun-5b.sh
rename to Sources/XToolDocs/Documentation.docc/First-app-code/rerun-5b.sh
diff --git a/Sources/xtool/Documentation.docc/First-app-code/rerun-6.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/rerun-6.sh
similarity index 100%
rename from Sources/xtool/Documentation.docc/First-app-code/rerun-6.sh
rename to Sources/XToolDocs/Documentation.docc/First-app-code/rerun-6.sh
diff --git a/Sources/xtool/Documentation.docc/First-app-code/template-1a.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/template-1a.sh
similarity index 100%
rename from Sources/xtool/Documentation.docc/First-app-code/template-1a.sh
rename to Sources/XToolDocs/Documentation.docc/First-app-code/template-1a.sh
diff --git a/Sources/xtool/Documentation.docc/First-app-code/template-1b.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/template-1b.sh
similarity index 100%
rename from Sources/xtool/Documentation.docc/First-app-code/template-1b.sh
rename to Sources/XToolDocs/Documentation.docc/First-app-code/template-1b.sh
diff --git a/Sources/xtool/Documentation.docc/First-app-code/template-2a.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/template-2a.sh
similarity index 100%
rename from Sources/xtool/Documentation.docc/First-app-code/template-2a.sh
rename to Sources/XToolDocs/Documentation.docc/First-app-code/template-2a.sh
diff --git a/Sources/xtool/Documentation.docc/First-app-code/template-2b.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/template-2b.sh
similarity index 100%
rename from Sources/xtool/Documentation.docc/First-app-code/template-2b.sh
rename to Sources/XToolDocs/Documentation.docc/First-app-code/template-2b.sh
diff --git a/Sources/xtool/Documentation.docc/First-app-code/template-3a.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/template-3a.sh
similarity index 100%
rename from Sources/xtool/Documentation.docc/First-app-code/template-3a.sh
rename to Sources/XToolDocs/Documentation.docc/First-app-code/template-3a.sh
diff --git a/Sources/xtool/Documentation.docc/First-app-code/template-3b.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/template-3b.sh
similarity index 100%
rename from Sources/xtool/Documentation.docc/First-app-code/template-3b.sh
rename to Sources/XToolDocs/Documentation.docc/First-app-code/template-3b.sh
diff --git a/Sources/xtool/Documentation.docc/First-app-code/template-4a.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/template-4a.sh
similarity index 100%
rename from Sources/xtool/Documentation.docc/First-app-code/template-4a.sh
rename to Sources/XToolDocs/Documentation.docc/First-app-code/template-4a.sh
diff --git a/Sources/xtool/Documentation.docc/First-app-code/template-4b.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/template-4b.sh
similarity index 100%
rename from Sources/xtool/Documentation.docc/First-app-code/template-4b.sh
rename to Sources/XToolDocs/Documentation.docc/First-app-code/template-4b.sh
diff --git a/Sources/xtool/Documentation.docc/First-app.tutorial b/Sources/XToolDocs/Documentation.docc/First-app.tutorial
similarity index 100%
rename from Sources/xtool/Documentation.docc/First-app.tutorial
rename to Sources/XToolDocs/Documentation.docc/First-app.tutorial
diff --git a/Sources/xtool/Documentation.docc/Installation-Linux.md b/Sources/XToolDocs/Documentation.docc/Installation-Linux.md
similarity index 100%
rename from Sources/xtool/Documentation.docc/Installation-Linux.md
rename to Sources/XToolDocs/Documentation.docc/Installation-Linux.md
diff --git a/Sources/xtool/Documentation.docc/Installation-macOS.md b/Sources/XToolDocs/Documentation.docc/Installation-macOS.md
similarity index 100%
rename from Sources/xtool/Documentation.docc/Installation-macOS.md
rename to Sources/XToolDocs/Documentation.docc/Installation-macOS.md
diff --git a/Sources/xtool/Documentation.docc/Resources/Autocomplete.png b/Sources/XToolDocs/Documentation.docc/Resources/Autocomplete.png
similarity index 100%
rename from Sources/xtool/Documentation.docc/Resources/Autocomplete.png
rename to Sources/XToolDocs/Documentation.docc/Resources/Autocomplete.png
diff --git a/Sources/xtool/Documentation.docc/Resources/Cover.png b/Sources/XToolDocs/Documentation.docc/Resources/Cover.png
similarity index 100%
rename from Sources/xtool/Documentation.docc/Resources/Cover.png
rename to Sources/XToolDocs/Documentation.docc/Resources/Cover.png
diff --git a/Sources/xtool/Documentation.docc/Resources/Developer.PNG b/Sources/XToolDocs/Documentation.docc/Resources/Developer.PNG
similarity index 100%
rename from Sources/xtool/Documentation.docc/Resources/Developer.PNG
rename to Sources/XToolDocs/Documentation.docc/Resources/Developer.PNG
diff --git a/Sources/xtool/Documentation.docc/Resources/HelloWorld-Purple.png b/Sources/XToolDocs/Documentation.docc/Resources/HelloWorld-Purple.png
similarity index 100%
rename from Sources/xtool/Documentation.docc/Resources/HelloWorld-Purple.png
rename to Sources/XToolDocs/Documentation.docc/Resources/HelloWorld-Purple.png
diff --git a/Sources/xtool/Documentation.docc/Resources/HelloWorld.png b/Sources/XToolDocs/Documentation.docc/Resources/HelloWorld.png
similarity index 100%
rename from Sources/xtool/Documentation.docc/Resources/HelloWorld.png
rename to Sources/XToolDocs/Documentation.docc/Resources/HelloWorld.png
diff --git a/Sources/xtool/Documentation.docc/Resources/Home.png b/Sources/XToolDocs/Documentation.docc/Resources/Home.png
similarity index 100%
rename from Sources/xtool/Documentation.docc/Resources/Home.png
rename to Sources/XToolDocs/Documentation.docc/Resources/Home.png
diff --git a/Sources/xtool/Documentation.docc/Resources/Hover.png b/Sources/XToolDocs/Documentation.docc/Resources/Hover.png
similarity index 100%
rename from Sources/xtool/Documentation.docc/Resources/Hover.png
rename to Sources/XToolDocs/Documentation.docc/Resources/Hover.png
diff --git a/Sources/xtool/Documentation.docc/Resources/Hover2.png b/Sources/XToolDocs/Documentation.docc/Resources/Hover2.png
similarity index 100%
rename from Sources/xtool/Documentation.docc/Resources/Hover2.png
rename to Sources/XToolDocs/Documentation.docc/Resources/Hover2.png
diff --git a/Sources/xtool/Documentation.docc/Resources/SwiftExtension.png b/Sources/XToolDocs/Documentation.docc/Resources/SwiftExtension.png
similarity index 100%
rename from Sources/xtool/Documentation.docc/Resources/SwiftExtension.png
rename to Sources/XToolDocs/Documentation.docc/Resources/SwiftExtension.png
diff --git a/Sources/xtool/Documentation.docc/Resources/Trust.png b/Sources/XToolDocs/Documentation.docc/Resources/Trust.png
similarity index 100%
rename from Sources/xtool/Documentation.docc/Resources/Trust.png
rename to Sources/XToolDocs/Documentation.docc/Resources/Trust.png
diff --git a/Sources/xtool/Documentation.docc/Resources/UntrustedDev.png b/Sources/XToolDocs/Documentation.docc/Resources/UntrustedDev.png
similarity index 100%
rename from Sources/xtool/Documentation.docc/Resources/UntrustedDev.png
rename to Sources/XToolDocs/Documentation.docc/Resources/UntrustedDev.png
diff --git a/Sources/xtool/Documentation.docc/Resources/Verified.png b/Sources/XToolDocs/Documentation.docc/Resources/Verified.png
similarity index 100%
rename from Sources/xtool/Documentation.docc/Resources/Verified.png
rename to Sources/XToolDocs/Documentation.docc/Resources/Verified.png
diff --git a/Sources/xtool/Documentation.docc/ToC.tutorial b/Sources/XToolDocs/Documentation.docc/ToC.tutorial
similarity index 100%
rename from Sources/xtool/Documentation.docc/ToC.tutorial
rename to Sources/XToolDocs/Documentation.docc/ToC.tutorial
diff --git a/Sources/XToolDocs/main.swift b/Sources/XToolDocs/main.swift
new file mode 100644
index 0000000..e69de29
diff --git a/scripts/build-docs.sh b/scripts/build-docs.sh
new file mode 100755
index 0000000..bc2f60e
--- /dev/null
+++ b/scripts/build-docs.sh
@@ -0,0 +1,9 @@
+#!/bin/bash
+
+set -euo pipefail
+
+rm -rf docs
+
+swift package --allow-writing-to-package-directory \
+ generate-documentation --target XToolDocs --disable-indexing \
+ --output-path docs