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.ymlnew file mode 100644index 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@v4diff --git a/.gitignore b/.gitignoreindex 590a95c..05120c3 100644--- a/.gitignore+++ b/.gitignore@@ -12,3 +12,4 @@ DerivedData/.docc-build/openapi+/docsdiff --git a/Package.swift b/Package.swiftindex 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.mdindex 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 Started1. 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)!## Examplesdiff --git a/Sources/xtool/Documentation.docc/Control.md b/Sources/XToolDocs/Documentation.docc/Control.mdsimilarity index 100%rename from Sources/xtool/Documentation.docc/Control.mdrename to Sources/XToolDocs/Documentation.docc/Control.mddiff --git a/Sources/xtool/Documentation.docc/Documentation.md b/Sources/XToolDocs/Documentation.docc/Documentation.mdsimilarity index 81%rename from Sources/xtool/Documentation.docc/Documentation.mdrename to Sources/XToolDocs/Documentation.docc/Documentation.mdindex 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 appdiff --git a/Sources/xtool/Documentation.docc/First-app-code/build-1a.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/build-1a.shsimilarity index 100%rename from Sources/xtool/Documentation.docc/First-app-code/build-1a.shrename to Sources/XToolDocs/Documentation.docc/First-app-code/build-1a.shdiff --git a/Sources/xtool/Documentation.docc/First-app-code/build-1b.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/build-1b.shsimilarity index 100%rename from Sources/xtool/Documentation.docc/First-app-code/build-1b.shrename to Sources/XToolDocs/Documentation.docc/First-app-code/build-1b.shdiff --git a/Sources/xtool/Documentation.docc/First-app-code/build-2.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/build-2.shsimilarity index 100%rename from Sources/xtool/Documentation.docc/First-app-code/build-2.shrename to Sources/XToolDocs/Documentation.docc/First-app-code/build-2.shdiff --git a/Sources/xtool/Documentation.docc/First-app-code/build-3.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/build-3.shsimilarity index 100%rename from Sources/xtool/Documentation.docc/First-app-code/build-3.shrename to Sources/XToolDocs/Documentation.docc/First-app-code/build-3.shdiff --git a/Sources/xtool/Documentation.docc/First-app-code/edit-2.swift b/Sources/XToolDocs/Documentation.docc/First-app-code/edit-2.swiftsimilarity index 100%rename from Sources/xtool/Documentation.docc/First-app-code/edit-2.swiftrename to Sources/XToolDocs/Documentation.docc/First-app-code/edit-2.swiftdiff --git a/Sources/xtool/Documentation.docc/First-app-code/edit-4.swift b/Sources/XToolDocs/Documentation.docc/First-app-code/edit-4.swiftsimilarity index 100%rename from Sources/xtool/Documentation.docc/First-app-code/edit-4.swiftrename to Sources/XToolDocs/Documentation.docc/First-app-code/edit-4.swiftdiff --git a/Sources/xtool/Documentation.docc/First-app-code/rerun-5a.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/rerun-5a.shsimilarity index 100%rename from Sources/xtool/Documentation.docc/First-app-code/rerun-5a.shrename to Sources/XToolDocs/Documentation.docc/First-app-code/rerun-5a.shdiff --git a/Sources/xtool/Documentation.docc/First-app-code/rerun-5b.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/rerun-5b.shsimilarity index 100%rename from Sources/xtool/Documentation.docc/First-app-code/rerun-5b.shrename to Sources/XToolDocs/Documentation.docc/First-app-code/rerun-5b.shdiff --git a/Sources/xtool/Documentation.docc/First-app-code/rerun-6.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/rerun-6.shsimilarity index 100%rename from Sources/xtool/Documentation.docc/First-app-code/rerun-6.shrename to Sources/XToolDocs/Documentation.docc/First-app-code/rerun-6.shdiff --git a/Sources/xtool/Documentation.docc/First-app-code/template-1a.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/template-1a.shsimilarity index 100%rename from Sources/xtool/Documentation.docc/First-app-code/template-1a.shrename to Sources/XToolDocs/Documentation.docc/First-app-code/template-1a.shdiff --git a/Sources/xtool/Documentation.docc/First-app-code/template-1b.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/template-1b.shsimilarity index 100%rename from Sources/xtool/Documentation.docc/First-app-code/template-1b.shrename to Sources/XToolDocs/Documentation.docc/First-app-code/template-1b.shdiff --git a/Sources/xtool/Documentation.docc/First-app-code/template-2a.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/template-2a.shsimilarity index 100%rename from Sources/xtool/Documentation.docc/First-app-code/template-2a.shrename to Sources/XToolDocs/Documentation.docc/First-app-code/template-2a.shdiff --git a/Sources/xtool/Documentation.docc/First-app-code/template-2b.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/template-2b.shsimilarity index 100%rename from Sources/xtool/Documentation.docc/First-app-code/template-2b.shrename to Sources/XToolDocs/Documentation.docc/First-app-code/template-2b.shdiff --git a/Sources/xtool/Documentation.docc/First-app-code/template-3a.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/template-3a.shsimilarity index 100%rename from Sources/xtool/Documentation.docc/First-app-code/template-3a.shrename to Sources/XToolDocs/Documentation.docc/First-app-code/template-3a.shdiff --git a/Sources/xtool/Documentation.docc/First-app-code/template-3b.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/template-3b.shsimilarity index 100%rename from Sources/xtool/Documentation.docc/First-app-code/template-3b.shrename to Sources/XToolDocs/Documentation.docc/First-app-code/template-3b.shdiff --git a/Sources/xtool/Documentation.docc/First-app-code/template-4a.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/template-4a.shsimilarity index 100%rename from Sources/xtool/Documentation.docc/First-app-code/template-4a.shrename to Sources/XToolDocs/Documentation.docc/First-app-code/template-4a.shdiff --git a/Sources/xtool/Documentation.docc/First-app-code/template-4b.sh b/Sources/XToolDocs/Documentation.docc/First-app-code/template-4b.shsimilarity index 100%rename from Sources/xtool/Documentation.docc/First-app-code/template-4b.shrename to Sources/XToolDocs/Documentation.docc/First-app-code/template-4b.shdiff --git a/Sources/xtool/Documentation.docc/First-app.tutorial b/Sources/XToolDocs/Documentation.docc/First-app.tutorialsimilarity index 100%rename from Sources/xtool/Documentation.docc/First-app.tutorialrename to Sources/XToolDocs/Documentation.docc/First-app.tutorialdiff --git a/Sources/xtool/Documentation.docc/Installation-Linux.md b/Sources/XToolDocs/Documentation.docc/Installation-Linux.mdsimilarity index 100%rename from Sources/xtool/Documentation.docc/Installation-Linux.mdrename to Sources/XToolDocs/Documentation.docc/Installation-Linux.mddiff --git a/Sources/xtool/Documentation.docc/Installation-macOS.md b/Sources/XToolDocs/Documentation.docc/Installation-macOS.mdsimilarity index 100%rename from Sources/xtool/Documentation.docc/Installation-macOS.mdrename to Sources/XToolDocs/Documentation.docc/Installation-macOS.mddiff --git a/Sources/xtool/Documentation.docc/Resources/Autocomplete.png b/Sources/XToolDocs/Documentation.docc/Resources/Autocomplete.pngsimilarity index 100%rename from Sources/xtool/Documentation.docc/Resources/Autocomplete.pngrename to Sources/XToolDocs/Documentation.docc/Resources/Autocomplete.pngdiff --git a/Sources/xtool/Documentation.docc/Resources/Cover.png b/Sources/XToolDocs/Documentation.docc/Resources/Cover.pngsimilarity index 100%rename from Sources/xtool/Documentation.docc/Resources/Cover.pngrename to Sources/XToolDocs/Documentation.docc/Resources/Cover.pngdiff --git a/Sources/xtool/Documentation.docc/Resources/Developer.PNG b/Sources/XToolDocs/Documentation.docc/Resources/Developer.PNGsimilarity index 100%rename from Sources/xtool/Documentation.docc/Resources/Developer.PNGrename to Sources/XToolDocs/Documentation.docc/Resources/Developer.PNGdiff --git a/Sources/xtool/Documentation.docc/Resources/HelloWorld-Purple.png b/Sources/XToolDocs/Documentation.docc/Resources/HelloWorld-Purple.pngsimilarity index 100%rename from Sources/xtool/Documentation.docc/Resources/HelloWorld-Purple.pngrename to Sources/XToolDocs/Documentation.docc/Resources/HelloWorld-Purple.pngdiff --git a/Sources/xtool/Documentation.docc/Resources/HelloWorld.png b/Sources/XToolDocs/Documentation.docc/Resources/HelloWorld.pngsimilarity index 100%rename from Sources/xtool/Documentation.docc/Resources/HelloWorld.pngrename to Sources/XToolDocs/Documentation.docc/Resources/HelloWorld.pngdiff --git a/Sources/xtool/Documentation.docc/Resources/Home.png b/Sources/XToolDocs/Documentation.docc/Resources/Home.pngsimilarity index 100%rename from Sources/xtool/Documentation.docc/Resources/Home.pngrename to Sources/XToolDocs/Documentation.docc/Resources/Home.pngdiff --git a/Sources/xtool/Documentation.docc/Resources/Hover.png b/Sources/XToolDocs/Documentation.docc/Resources/Hover.pngsimilarity index 100%rename from Sources/xtool/Documentation.docc/Resources/Hover.pngrename to Sources/XToolDocs/Documentation.docc/Resources/Hover.pngdiff --git a/Sources/xtool/Documentation.docc/Resources/Hover2.png b/Sources/XToolDocs/Documentation.docc/Resources/Hover2.pngsimilarity index 100%rename from Sources/xtool/Documentation.docc/Resources/Hover2.pngrename to Sources/XToolDocs/Documentation.docc/Resources/Hover2.pngdiff --git a/Sources/xtool/Documentation.docc/Resources/SwiftExtension.png b/Sources/XToolDocs/Documentation.docc/Resources/SwiftExtension.pngsimilarity index 100%rename from Sources/xtool/Documentation.docc/Resources/SwiftExtension.pngrename to Sources/XToolDocs/Documentation.docc/Resources/SwiftExtension.pngdiff --git a/Sources/xtool/Documentation.docc/Resources/Trust.png b/Sources/XToolDocs/Documentation.docc/Resources/Trust.pngsimilarity index 100%rename from Sources/xtool/Documentation.docc/Resources/Trust.pngrename to Sources/XToolDocs/Documentation.docc/Resources/Trust.pngdiff --git a/Sources/xtool/Documentation.docc/Resources/UntrustedDev.png b/Sources/XToolDocs/Documentation.docc/Resources/UntrustedDev.pngsimilarity index 100%rename from Sources/xtool/Documentation.docc/Resources/UntrustedDev.pngrename to Sources/XToolDocs/Documentation.docc/Resources/UntrustedDev.pngdiff --git a/Sources/xtool/Documentation.docc/Resources/Verified.png b/Sources/XToolDocs/Documentation.docc/Resources/Verified.pngsimilarity index 100%rename from Sources/xtool/Documentation.docc/Resources/Verified.pngrename to Sources/XToolDocs/Documentation.docc/Resources/Verified.pngdiff --git a/Sources/xtool/Documentation.docc/ToC.tutorial b/Sources/XToolDocs/Documentation.docc/ToC.tutorialsimilarity index 100%rename from Sources/xtool/Documentation.docc/ToC.tutorialrename to Sources/XToolDocs/Documentation.docc/ToC.tutorialdiff --git a/Sources/XToolDocs/main.swift b/Sources/XToolDocs/main.swiftnew file mode 100644index 0000000..e69de29diff --git a/scripts/build-docs.sh b/scripts/build-docs.shnew file mode 100755index 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