GitHub Pages (#56)
@@ -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
|
||||
@@ -12,3 +12,4 @@ DerivedData/
|
||||
.docc-build
|
||||
|
||||
/openapi
|
||||
/docs
|
||||
|
||||
@@ -161,5 +161,8 @@ let package = Package(
|
||||
],
|
||||
cSettings: cSettings
|
||||
),
|
||||
.executableTarget(
|
||||
name: "XToolDocs"
|
||||
),
|
||||
]
|
||||
)
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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
|
||||
|
Before Width: | Height: | Size: 286 KiB After Width: | Height: | Size: 286 KiB |
|
Before Width: | Height: | Size: 948 KiB After Width: | Height: | Size: 948 KiB |
|
Before Width: | Height: | Size: 84 KiB After Width: | Height: | Size: 84 KiB |
|
Before Width: | Height: | Size: 61 KiB After Width: | Height: | Size: 61 KiB |
|
Before Width: | Height: | Size: 61 KiB After Width: | Height: | Size: 61 KiB |
|
Before Width: | Height: | Size: 5.0 MiB After Width: | Height: | Size: 5.0 MiB |
|
Before Width: | Height: | Size: 222 KiB After Width: | Height: | Size: 222 KiB |
|
Before Width: | Height: | Size: 316 KiB After Width: | Height: | Size: 316 KiB |
|
Before Width: | Height: | Size: 232 KiB After Width: | Height: | Size: 232 KiB |
|
Before Width: | Height: | Size: 142 KiB After Width: | Height: | Size: 142 KiB |
|
Before Width: | Height: | Size: 2.3 MiB After Width: | Height: | Size: 2.3 MiB |
|
Before Width: | Height: | Size: 127 KiB After Width: | Height: | Size: 127 KiB |
@@ -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
|
||||