Skip to content

Commit 01af58e

Browse files
authored
Link to docs in GH Pages (#33)
1 parent 312c8fa commit 01af58e

File tree

6 files changed

+23
-290
lines changed

6 files changed

+23
-290
lines changed

.spi.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ builder:
33
configs:
44
- platform: ios
55
scheme: NavigationTransitions
6-
documentation_targets: [NavigationTransitions, NavigationTransition, AtomicTransition, Animator, Animation]
7-
- platform: macos-xcodebuild
8-
scheme: NavigationTransitions
6+
documentation_targets: [NavigationTransitions]
97
- platform: tvos
108
scheme: NavigationTransitions

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ The library ships with some **standard transitions** out of the box:
7676
- [`fade(_:)`](Sources/NavigationTransition/Fade.swift)
7777
- [`slide(axis:)`](Sources/NavigationTransition/Slide.swift)
7878

79-
In addition to these, you can create fully [**custom**](Demo/Demo/Swing.swift) transitions in just a few lines of SwiftUI-like code!
79+
In addition to these, you can create fully [**custom transitions**](https://davdroman.github.io/swiftui-navigation-transitions/main/documentation/navigationtransitions/custom-transitions/) in just a few lines of SwiftUI-like code!
8080

8181
```swift
8282
struct Swing: NavigationTransition {
@@ -105,8 +105,6 @@ struct Swing: NavigationTransition {
105105
}
106106
```
107107

108-
Check out the [**documentation**](Documentation/Custom-Transitions.md) to learn more about custom transitions.
109-
110108
The [**Demo**](Demo) app showcases some of these transitions in action.
111109

112110
### Interactivity
@@ -127,8 +125,8 @@ This even works to override its behavior while maintaining the **default system
127125

128126
The documentation for releases and `main` are available here:
129127

130-
- [`main`](https://swiftpackageindex.com/davdroman/swiftui-navigation-transitions/main/documentation/navigationtransitions)
131-
- [0.2.0](https://swiftpackageindex.com/davdroman/swiftui-navigation-transitions/0.2.0/documentation/navigationtransitions)
128+
- [`main`](https://davdroman.github.io/swiftui-navigation-transitions/main/documentation/navigationtransitions/)
129+
- [0.5.0](https://davdroman.github.io/swiftui-navigation-transitions/0.5.0/documentation/navigationtransitions/)
132130

133131
The repository also contains [**documentation**](Documentation/Custom-Transitions.md) covering how to set up your own **custom transitions**.
134132

Sources/NavigationTransition/Documentation.docc/Custom-Transitions.md

Lines changed: 0 additions & 282 deletions
This file was deleted.
File renamed without changes.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1+
@_exported import Animation
2+
@_exported import Animator
3+
@_exported import AtomicTransition
14
@_exported import NavigationTransition

scripts/generate-docs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
#!/usr/bin/env bash
2+
3+
killall Xcode
4+
5+
xcodebuild docbuild \
6+
-scheme NavigationTransitions \
7+
-destination generic/platform=iOS \
8+
OTHER_DOCC_FLAGS="--transform-for-static-hosting --hosting-base-path /swiftui-navigation-transitions/$1 --output-path $1"
9+
10+
git checkout docs
11+
12+
git add .
13+
git commit -m "Generate docs for $1"
14+
git push origin docs
15+
16+
git checkout -

0 commit comments

Comments
 (0)