Cross-platform Xcode replacement. Build and deploy iOS apps with SwiftPM on Linux, Windows, macOS.
More DocC improvements (#65)
Kabir Oberai26e076b95f6b
diff --git a/.spi.yml b/.spi.ymldeleted file mode 100644index fadcfb8..0000000--- a/.spi.yml+++ /dev/null@@ -1,14 +0,0 @@-version: 1-builder:- configs:- - scheme: xtool- platform: macosSpm- documentation_targets:- - xtool- - scheme: xtool- platform: macosXcodebuild- - scheme: xtool- platform: linux- image: kabiroberai/xtool-dev:latest- - scheme: XKit- platform: iosdiff --git a/Netlify/.gitignore b/Documentation/.gitignoresimilarity index 100%rename from Netlify/.gitignorerename to Documentation/.gitignorediff --git a/Documentation/build.sh b/Documentation/build.shnew file mode 100755index 0000000..0e16787--- /dev/null+++ b/Documentation/build.sh@@ -0,0 +1,26 @@+#!/bin/bash++set -euo pipefail++cd "$(dirname "$0")"++rm -rf docs++if type -p xcrun &>/dev/null; then+ docc="$(xcrun -f docc)"+else+ docc="docc"+fi++if [[ $# == 0 ]]; then+ command="convert"+elif [[ $# == 1 && ( "$1" == "preview" || "$1" == "convert" ) ]]; then+ command="$1"+else+ echo "Usage: $0 [convert|preview]"+ exit 1+fi++"$docc" "$command" xtool.docc \+ --experimental-enable-custom-templates \+ --output-path docsdiff --git a/Sources/XToolDocs/Documentation.docc/Control.md b/Documentation/xtool.docc/Control.mdsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/Control.mdrename to Documentation/xtool.docc/Control.mddiff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/build-1a.sh b/Documentation/xtool.docc/First-app-code/build-1a.shsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/First-app-code/build-1a.shrename to Documentation/xtool.docc/First-app-code/build-1a.shdiff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/build-1b.sh b/Documentation/xtool.docc/First-app-code/build-1b.shsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/First-app-code/build-1b.shrename to Documentation/xtool.docc/First-app-code/build-1b.shdiff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/build-2.sh b/Documentation/xtool.docc/First-app-code/build-2.shsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/First-app-code/build-2.shrename to Documentation/xtool.docc/First-app-code/build-2.shdiff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/build-3.sh b/Documentation/xtool.docc/First-app-code/build-3.shsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/First-app-code/build-3.shrename to Documentation/xtool.docc/First-app-code/build-3.shdiff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/edit-2.swift b/Documentation/xtool.docc/First-app-code/edit-2.swiftsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/First-app-code/edit-2.swiftrename to Documentation/xtool.docc/First-app-code/edit-2.swiftdiff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/edit-4.swift b/Documentation/xtool.docc/First-app-code/edit-4.swiftsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/First-app-code/edit-4.swiftrename to Documentation/xtool.docc/First-app-code/edit-4.swiftdiff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/rerun-5a.sh b/Documentation/xtool.docc/First-app-code/rerun-5a.shsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/First-app-code/rerun-5a.shrename to Documentation/xtool.docc/First-app-code/rerun-5a.shdiff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/rerun-5b.sh b/Documentation/xtool.docc/First-app-code/rerun-5b.shsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/First-app-code/rerun-5b.shrename to Documentation/xtool.docc/First-app-code/rerun-5b.shdiff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/rerun-6.sh b/Documentation/xtool.docc/First-app-code/rerun-6.shsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/First-app-code/rerun-6.shrename to Documentation/xtool.docc/First-app-code/rerun-6.shdiff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/template-1a.sh b/Documentation/xtool.docc/First-app-code/template-1a.shsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/First-app-code/template-1a.shrename to Documentation/xtool.docc/First-app-code/template-1a.shdiff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/template-1b.sh b/Documentation/xtool.docc/First-app-code/template-1b.shsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/First-app-code/template-1b.shrename to Documentation/xtool.docc/First-app-code/template-1b.shdiff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/template-2a.sh b/Documentation/xtool.docc/First-app-code/template-2a.shsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/First-app-code/template-2a.shrename to Documentation/xtool.docc/First-app-code/template-2a.shdiff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/template-2b.sh b/Documentation/xtool.docc/First-app-code/template-2b.shsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/First-app-code/template-2b.shrename to Documentation/xtool.docc/First-app-code/template-2b.shdiff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/template-3a.sh b/Documentation/xtool.docc/First-app-code/template-3a.shsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/First-app-code/template-3a.shrename to Documentation/xtool.docc/First-app-code/template-3a.shdiff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/template-3b.sh b/Documentation/xtool.docc/First-app-code/template-3b.shsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/First-app-code/template-3b.shrename to Documentation/xtool.docc/First-app-code/template-3b.shdiff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/template-4a.sh b/Documentation/xtool.docc/First-app-code/template-4a.shsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/First-app-code/template-4a.shrename to Documentation/xtool.docc/First-app-code/template-4a.shdiff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/template-4b.sh b/Documentation/xtool.docc/First-app-code/template-4b.shsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/First-app-code/template-4b.shrename to Documentation/xtool.docc/First-app-code/template-4b.shdiff --git a/Sources/XToolDocs/Documentation.docc/First-app.tutorial b/Documentation/xtool.docc/First-app.tutorialsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/First-app.tutorialrename to Documentation/xtool.docc/First-app.tutorialdiff --git a/Sources/XToolDocs/Documentation.docc/Installation-Linux.md b/Documentation/xtool.docc/Installation-Linux.mdsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/Installation-Linux.mdrename to Documentation/xtool.docc/Installation-Linux.mddiff --git a/Sources/XToolDocs/Documentation.docc/Installation-macOS.md b/Documentation/xtool.docc/Installation-macOS.mdsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/Installation-macOS.mdrename to Documentation/xtool.docc/Installation-macOS.mddiff --git a/Sources/XToolDocs/Documentation.docc/Resources/Autocomplete.png b/Documentation/xtool.docc/Resources/Autocomplete.pngsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/Resources/Autocomplete.pngrename to Documentation/xtool.docc/Resources/Autocomplete.pngdiff --git a/Sources/XToolDocs/Documentation.docc/Resources/Cover.png b/Documentation/xtool.docc/Resources/Cover.pngsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/Resources/Cover.pngrename to Documentation/xtool.docc/Resources/Cover.pngdiff --git a/Sources/XToolDocs/Documentation.docc/Resources/Developer.PNG b/Documentation/xtool.docc/Resources/Developer.PNGsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/Resources/Developer.PNGrename to Documentation/xtool.docc/Resources/Developer.PNGdiff --git a/Sources/XToolDocs/Documentation.docc/Resources/HelloWorld-Purple.png b/Documentation/xtool.docc/Resources/HelloWorld-Purple.pngsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/Resources/HelloWorld-Purple.pngrename to Documentation/xtool.docc/Resources/HelloWorld-Purple.pngdiff --git a/Sources/XToolDocs/Documentation.docc/Resources/HelloWorld.png b/Documentation/xtool.docc/Resources/HelloWorld.pngsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/Resources/HelloWorld.pngrename to Documentation/xtool.docc/Resources/HelloWorld.pngdiff --git a/Sources/XToolDocs/Documentation.docc/Resources/Home.png b/Documentation/xtool.docc/Resources/Home.pngsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/Resources/Home.pngrename to Documentation/xtool.docc/Resources/Home.pngdiff --git a/Sources/XToolDocs/Documentation.docc/Resources/Hover.png b/Documentation/xtool.docc/Resources/Hover.pngsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/Resources/Hover.pngrename to Documentation/xtool.docc/Resources/Hover.pngdiff --git a/Sources/XToolDocs/Documentation.docc/Resources/Hover2.png b/Documentation/xtool.docc/Resources/Hover2.pngsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/Resources/Hover2.pngrename to Documentation/xtool.docc/Resources/Hover2.pngdiff --git a/Sources/XToolDocs/Documentation.docc/Resources/SwiftExtension.png b/Documentation/xtool.docc/Resources/SwiftExtension.pngsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/Resources/SwiftExtension.pngrename to Documentation/xtool.docc/Resources/SwiftExtension.pngdiff --git a/Sources/XToolDocs/Documentation.docc/Resources/Trust.png b/Documentation/xtool.docc/Resources/Trust.pngsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/Resources/Trust.pngrename to Documentation/xtool.docc/Resources/Trust.pngdiff --git a/Sources/XToolDocs/Documentation.docc/Resources/UntrustedDev.png b/Documentation/xtool.docc/Resources/UntrustedDev.pngsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/Resources/UntrustedDev.pngrename to Documentation/xtool.docc/Resources/UntrustedDev.pngdiff --git a/Sources/XToolDocs/Documentation.docc/Resources/Verified.png b/Documentation/xtool.docc/Resources/Verified.pngsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/Resources/Verified.pngrename to Documentation/xtool.docc/Resources/Verified.pngdiff --git a/Sources/XToolDocs/Documentation.docc/footer.html b/Documentation/xtool.docc/footer.htmlsimilarity index 92%rename from Sources/XToolDocs/Documentation.docc/footer.htmlrename to Documentation/xtool.docc/footer.htmlindex 329a283..cbfe10e 100644--- a/Sources/XToolDocs/Documentation.docc/footer.html+++ b/Documentation/xtool.docc/footer.html@@ -2,7 +2,7 @@footer {display: flex;justify-content: center;- padding: 0.5rem 0;+ padding: 0.5rem 0.8rem;background-color: var(--color-fill-secondary);text-align: center;}diff --git a/Sources/XToolDocs/Documentation.docc/Documentation.md b/Documentation/xtool.docc/xtool.mdsimilarity index 93%rename from Sources/XToolDocs/Documentation.docc/Documentation.mdrename to Documentation/xtool.docc/xtool.mdindex dd3c15f..2c58d8a 100644--- a/Sources/XToolDocs/Documentation.docc/Documentation.md+++ b/Documentation/xtool.docc/xtool.md@@ -1,7 +1,7 @@-# ``XToolDocs``+# xtool@Metadata {- @DisplayName("xtool")+ @TechnologyRoot}Cross-platform Xcode replacement.diff --git a/Sources/XToolDocs/Documentation.docc/ToC.tutorial b/Documentation/xtool.docc/xtool.tutorialsimilarity index 100%rename from Sources/XToolDocs/Documentation.docc/ToC.tutorialrename to Documentation/xtool.docc/xtool.tutorialdiff --git a/Netlify/build.sh b/Netlify/build.shdeleted file mode 100755index 50a9d34..0000000--- a/Netlify/build.sh+++ /dev/null@@ -1,12 +0,0 @@-#!/bin/bash--set -euo pipefail--cd "$(dirname "$0")"--rm -rf docs--swift package --allow-writing-to-package-directory \- generate-documentation --target XToolDocs --disable-indexing \- --experimental-enable-custom-templates \- --output-path docsdiff --git a/Package.swift b/Package.swiftindex b83ca5e..8237c1a 100644--- a/Package.swift+++ b/Package.swift@@ -161,8 +161,5 @@ let package = Package(],cSettings: cSettings),- .executableTarget(- name: "XToolDocs"- ),])diff --git a/Sources/XToolDocs/main.swift b/Sources/XToolDocs/main.swiftdeleted file mode 100644index e69de29..0000000diff --git a/netlify.toml b/netlify.tomlindex 651f651..56dc869 100644--- a/netlify.toml+++ b/netlify.toml@@ -2,36 +2,43 @@# by setting a custom base directory, we prevent Netlify from running# `swift build` in the root directory, which builds more targets than# we need.- base = "Netlify/"+ base = "Documentation/"publish = "docs/"command = "./build.sh"environment = { SWIFT_VERSION = "6.1" }- ignore = "git -C .. diff --quiet $CACHED_COMMIT_REF $COMMIT_REF -- Sources/XToolDocs Netlify netlify.toml"+ ignore = "git -C .. diff --quiet $CACHED_COMMIT_REF $COMMIT_REF -- Documentation netlify.toml"[[redirects]]from = "/"- to = "/documentation/xtooldocs/"+ to = "/documentation/xtool/"status = 302force = true[[redirects]]from = "/documentation"- to = "/documentation/xtooldocs/"+ to = "/documentation/xtool/"status = 302force = true[[redirects]]from = "/tutorials"- to = "/tutorials/toc"+ to = "/tutorials/xtool"status = 302force = true+# --- Backwards compatibility ---++[[redirects]]+ from = "/tutorials/toc"+ to = "/tutorials/xtool"+ status = 302+[[redirects]]- from = "/documentation/xtool/*"- to = "/documentation/xtooldocs/:splat"+ from = "/documentation/xtooldocs/*"+ to = "/documentation/xtool/:splat"status = 302[[redirects]]- from = "/tutorials/xtool/*"- to = "/tutorials/xtooldocs/:splat"+ from = "/tutorials/xtooldocs/*"+ to = "/tutorials/xtool/:splat"status = 302