Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation URL #63

Merged
merged 1 commit into from
Jan 30, 2024
+4 −4
Merged

Update documentation URL #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ lint:
.PHONY: docs
docs:
xcodebuild docbuild \
-scheme PlaybookUI \
-scheme PlaybookSnapshot \
-destination generic/platform=iOS \
OTHER_DOCC_FLAGS="--transform-for-static-hosting --hosting-base-path playbook-ios --output-dir docs"
OTHER_DOCC_FLAGS="--transform-for-static-hosting --hosting-base-path playbook-ios --output-path docs"

.PHONY: npm
npm:
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,15 @@ With the `Playbook`, you don't have to struggle through preparing the data and s

## Usage

- [API Document](https://playbook-ui.github.io/playbook-ios)
- [API Document](https://playbook-ui.github.io/playbook-ios/documentation/playbooksnapshot)
- [Example App](https://github.com/playbook-ui/playbook-ios/tree/master/Example)

---

### Playbook

`Playbook` is a framework that provides the basic functionality for managing components. It supports both `SwiftUI` and `UIKit`.
Components are uniquely stored as scenarios. A `Scenario` has the way to layout component. Please check the [API Doc](https://playbook-ui.github.io/playbook-ios/ScenarioLayout/) for the variety of layouts.
Components are uniquely stored as scenarios. A `Scenario` has the way to layout component. Please check the API Doc for the variety of layouts.

```swift
Playbook.default.addScenarios(of: "Home") {
Expand Down
Loading