Skip to content

Commit

Permalink
Setting up DocC & spi
Browse files Browse the repository at this point in the history
  • Loading branch information
Archdoog committed Feb 26, 2024
1 parent a95c12b commit a1a2a93
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 2 deletions.
5 changes: 5 additions & 0 deletions .spi.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
version: 1
builder:
configs:
- documentation_targets: [MapLibreSwiftUI]
platform: ios
4 changes: 2 additions & 2 deletions Package.resolved
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/maplibre/maplibre-gl-native-distribution.git",
"state" : {
"revision" : "3df876f8f2c6c591b0f66a29b3e216020afc885c",
"version" : "6.0.0"
"revision" : "818e1d6b83e4cbe8482eca3e6e57d3f560926157",
"version" : "6.1.1"
}
},
{
Expand Down
38 changes: 38 additions & 0 deletions Sources/MapLibreSwiftUI/Documentation.docc/MapLibreSwiftUI.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# ``MapLibreSwiftUI``

A SwiftUI framework for Maplibre Native iOS. Provides declarative methods for MapLibre inspired by default SwiftUI functionality.

## Overview

```swift
struct MyView: View {

@State var camera: MapViewCamera = .default()

var body: some View {
MapView(
styleURL: URL(string: "https://demotiles.maplibre.org/style.json")!,
camera: $camera
) {
// Declarative overlay features.
}
.onTapMapGesture { context in
// Handle tap gesture context
}
}
}
```

## Topics

### MapView

- ``MapView``

### MapViewCamera

- ``MapViewCamera``
- ``CameraState``
- ``CameraPitch``
- ``CameraChangeReason``

0 comments on commit a1a2a93

Please sign in to comment.