summaryrefslogtreecommitdiff
path: root/platform/macos
diff options
context:
space:
mode:
authorJason Wray <jason@mapbox.com>2016-06-09 17:47:41 -0700
committerJason Wray <jason@mapbox.com>2016-07-01 14:44:51 -0400
commitbacf8eee70f3c1a2075702e8ef82b6f1204d671e (patch)
treea30bb5a8f8fe0b5e61c89c6e55e7f8d896974baf /platform/macos
parent5389f04da5f66c5e26d71e761a0fcda4d8382581 (diff)
downloadqtlocation-mapboxgl-bacf8eee70f3c1a2075702e8ef82b6f1204d671e.tar.gz
[ios, macos] Add Mapbox Jazzy theme
- Based on Jazzy's "full width" theme. - Add ellipsis to overlong items in navigation menu. - Set minimum width for navigation menu. - Use Open Sans font face. - Inline GitHub header icon as SVG. - Center images by default. - Add GitHub SVG icon to 'show on github' link. - Wrap overlong method names on class pages.
Diffstat (limited to 'platform/macos')
-rw-r--r--platform/macos/docs/doc-README.md2
-rwxr-xr-xplatform/macos/scripts/document.sh3
2 files changed, 4 insertions, 1 deletions
diff --git a/platform/macos/docs/doc-README.md b/platform/macos/docs/doc-README.md
index b037da19d4..58dc6001df 100644
--- a/platform/macos/docs/doc-README.md
+++ b/platform/macos/docs/doc-README.md
@@ -2,7 +2,7 @@
The Mapbox macOS SDK is an open-source framework for embedding interactive map views with scalable, customizable vector maps into Cocoa applications on macOS 10.10.0 and above using Objective-C, Swift, or Interface Builder. It takes stylesheets that conform to the [Mapbox GL Style Specification](https://www.mapbox.com/mapbox-gl-style-spec/), applies them to vector tiles that conform to the [Mapbox Vector Tile Specification](https://www.mapbox.com/developers/vector-tiles/), and renders them using OpenGL.
-<img alt="" src="https://raw.githubusercontent.com/mapbox/mapbox-gl-native/master/platform/macos/screenshot.png" width="645">
+<img alt="Mapbox macOS SDK screenshot" src="screenshot.png" width="645">
For setup information, consult the README.md that comes with this documentation. The [Mapbox iOS SDK](https://www.mapbox.com/ios-sdk/)’s [API documentation](https://www.mapbox.com/ios-sdk/api/) and [online examples](https://www.mapbox.com/ios-sdk/examples/) apply to the Mapbox macOS SDK with few differences, mostly around unimplemented features like user location tracking. A [full changelog](https://github.com/mapbox/mapbox-gl-native/blob/master/platform/macos/CHANGELOG.md) is also available.
diff --git a/platform/macos/scripts/document.sh b/platform/macos/scripts/document.sh
index e62a1e1668..526aecb7d1 100755
--- a/platform/macos/scripts/document.sh
+++ b/platform/macos/scripts/document.sh
@@ -32,6 +32,8 @@ sed -n -e '/^## /{' -e ':a' -e 'n' -e '/^##/q' -e 'p' -e 'ba' -e '}' platform/ma
rm -rf ${OUTPUT}
mkdir -p ${OUTPUT}
+cp platform/macos/screenshot.png "${OUTPUT}"
+
jazzy \
--config platform/macos/jazzy.yml \
--sdk macosx \
@@ -39,6 +41,7 @@ jazzy \
--github-file-prefix https://github.com/mapbox/mapbox-gl-native/tree/${BRANCH} \
--module-version ${SHORT_VERSION} \
--readme ${README} \
+ --theme platform/darwin/docs/theme \
--output ${OUTPUT}
# https://github.com/realm/jazzy/issues/411
find ${OUTPUT} -name *.html -exec \