diff --git a/documentation/docfx_project/docfx.json b/documentation/docfx_project/docfx.json index 29115d05f..e0351872b 100644 --- a/documentation/docfx_project/docfx.json +++ b/documentation/docfx_project/docfx.json @@ -140,7 +140,8 @@ "globalMetadataFiles": [], "fileMetadataFiles": [], "template": [ - "default" + "default", + "template" ], "postProcessors": [], "noLangKeyword": false diff --git a/documentation/docfx_project/template/dashboard.html.liquid b/documentation/docfx_project/template/dashboard.html.liquid new file mode 100644 index 000000000..3610ad544 --- /dev/null +++ b/documentation/docfx_project/template/dashboard.html.liquid @@ -0,0 +1,85 @@ +{% comment -%}Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.{% endcomment -%} +{% ref /^styles/.*/ -%} +{% ref /^fonts/.*/ -%} +{% ref favicon.ico -%} +{% ref logo.svg -%} + + + + {% include partials/head -%} + + +
+
+ {% include partials/navbar -%} + {% include partials/breadcrumb -%} +
+
+ {% include partials/toc -%} +
+ + Add Your Own Template + + {{rawTitle}} + {{conceptual}} + {%- if templates -%} +
    + {%- for template in templates -%} +
  • +
    + +
    + {{template.name}} +

    {{template.description}}

    + {%- if template.usage -%} +
      + {%- if template.usage.init -%} +
    • Init:{{template.usage.init | escape}}
    • + {%- endif -%} + {%- if template.usage.command -%} +
    • In command:{{template.usage.command | escape}}
    • + {%- endif -%} + {%- if template.usage.config -%} +
    • In docfx.json:{{template.usage.config | escape}}
    • + {%- endif -%} +
    + {%- endif -%} +
  • + {%- endfor -%} +
+ {%- endif -%} +
+
+ {% include partials/footer -%} +
+ {% include partials/scripts -%} + + \ No newline at end of file diff --git a/documentation/docfx_project/template/index.html.tmpl b/documentation/docfx_project/template/index.html.tmpl new file mode 100644 index 000000000..23c520417 --- /dev/null +++ b/documentation/docfx_project/template/index.html.tmpl @@ -0,0 +1,20 @@ +{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!include(/^styles/.*/)}} +{{!include(/^fonts/.*/)}} +{{!include(favicon.ico)}} +{{!include(logo.svg)}} + + + + {{>partials/head}} + +
+
+ {{>partials/navbar}} +
+ {{{conceptual}}} + {{>partials/footer}} +
+ {{>partials/scripts}} + + \ No newline at end of file diff --git a/documentation/docfx_project/template/styles/main.css b/documentation/docfx_project/template/styles/main.css new file mode 100644 index 000000000..815fbd1cd --- /dev/null +++ b/documentation/docfx_project/template/styles/main.css @@ -0,0 +1,151 @@ +/* Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License.txt in the project root for license information. */ +/* Colors */ +button, a, .btn-primary { + color: #47A7A0; +} +.btn-primary:hover, .btn-primary:focus, button:hover, button:focus, a:hover, a:focus, .toc .nav > li.active > a:hover, .toc .nav > li.active > a:focus, .toc .nav > li > a:hover, .toc .nav > li > a:focus { + color: #6E8B60; +} +.btn-primary.disable, .btn-primary.disable:hover, a.disable, a.disable:hover{ + color: #90ABB9; +} +.hero { + color: #C1D38B; + background-color: #385361; + background-image: -webkit-gradient(linear,left bottom,right top,color-stop(0%,#000),color-stop(100%,#385361)); + background-image: -webkit-linear-gradient(45deg,#000 0,#385361 100%); + background-image: -moz-linear-gradient(45deg,#000 0,#385361 100%); + background-image: -ms-linear-gradient(45deg,#000 0,#385361 100%); + background-image: -o-linear-gradient(45deg,#000 0,#385361 100%); + background-image: linear-gradient(45deg,#000 0,#385361 100%); + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#000', endColorstr='#385361', GradientType=1); + +} +.hero strong { + color: #e7e7e7; +} +.buttons-unit .button { + color: #fff; + background: #6E8B60; +} +.buttons-unit .button:active { + background: #A27865; +} +.toc .nav > li.active > a, .affix ul > li.active > a, .affix ul > li.active > a:before { + color: #6E8B60 +} +.btn-primary { + background: #385361; + color: #8BFEB4; +} + +.affix ul > li > a:before { + color: #cccccc; +} +.toc .nav > li > a, .affix ul > li > a, .affix ul > li > a:hover { + color: #666666; +} + +svg:hover path { + fill: #ffffff; +} + +.counter-key-section{ + border: 2px solid #6E8B60; + -webkit-border-image-source: -webkit-gradient(linear, left, right, color-stop(0%, rgba(0, 0, 0, 0)), color-stop(50%, #385361), color-stop(100%, rgba(0, 0, 0, 0))); + -webkit-border-image-source: -webkit-linear-gradient(90deg, rgba(0, 0, 0, 0), #385361 50%, rgba(0, 0, 0, 0)); + -moz-border-image-source: -moz-linear-gradient(90deg, rgba(0, 0, 0, 0), #385361 50%, rgba(0, 0, 0, 0)); + -ms-border-image-source: -ms-linear-gradient(90deg, rgba(0, 0, 0, 0), #385361 50%, rgba(0, 0, 0, 0)); + -o-border-image-source: -o-linear-gradient(90deg, rgba(0, 0, 0, 0), #385361 50%, rgba(0, 0, 0, 0)); + border-image-source: linear-gradient(90deg, rgba(0, 0, 0, 0), #385361 50%, rgba(0, 0, 0, 0)); + border-image-slice: 1; +} + +/* End Colors */ + +.value-prop-heading { + font-size: 24px; +} + +#vp-container{ + margin-top: 30px; +} + +.hero { + height: 350px; + margin-top: 50px; + padding-top: 50px; + font-weight: 300; + text-align: center; +} +.key-section{ + padding: 30px 0; +} + +.key-section .glyphicon, .counter-key-section .glyphicon { + font-size: 4em; + display: table-cell; + vertical-align: middle; +} +.glyphicon { + margin-right: 10px; + font-size: 16px; +} + +.key-section section, .counter-key-section section { + display: table-cell; + padding-left: 20px; +} + +.key-section section p, .counter-key-section section p { + text-align: initial; +} + +.counter-key-section{ + padding: 30px 0; +} +.buttons-unit-small{ + font-size: 16px; +} +.version-link, .github-link{ + margin: 5px; +} +.hero strong { + font-weight: 400; + font-family: Rockwell; +} +.hero .text { + font-size: 64px; + text-align: center; + color: white; +} +.hero .minitext { + font-size: 20px; + text-align: center; + font-family: Candara; + color: white; +} +.buttons-unit { + margin-top: 60px; + text-align: center; +} +.hero .button { + border-radius: 4px; + padding: 8px 16px; + margin: 0 12px; + box-shadow: 1px 3px 3px rgba(0,0,0,0.3); +} +.buttons-unit .button { + font-size: 24px; +} + +@media only screen and (max-width: 768px) { + .hero { + height: 500px; + margin-top: 0px; + } + .hero .button { + display: block; + margin: 12px; + } +} \ No newline at end of file diff --git a/documentation/docfx_project/toc.yml b/documentation/docfx_project/toc.yml index cdadafc84..3b30d1b18 100644 --- a/documentation/docfx_project/toc.yml +++ b/documentation/docfx_project/toc.yml @@ -1,6 +1,6 @@ -- name: API +- name: API Documentation tocHref: api/toc.yml topicHref: api/ -- name: Documentation +- name: Tutorials & Guides tocHref: ../docs/toc.yml diff --git a/documentation/docs/00-getting-started.md b/documentation/docs/00-getting-started.md index b3637c429..ada0fc7f6 100644 --- a/documentation/docs/00-getting-started.md +++ b/documentation/docs/00-getting-started.md @@ -1,23 +1,53 @@ # Getting Started -* [Get a Mapbox API token](01-mapbox-api-token.md) -* [Check out known issues](02-known-issues.md) -* [Check out C# API documentation](https://mapbox.github.io/mapbox-unity-sdk/api/index.html) +## Installation from Unity Package -## Download Unity Package +1. Visit https://www.mapbox.com/unity/ -* Go to https://www.mapbox.com/unity/ -* Click `Download the SDK` - * Assets—>Import package—>Custom Package (from the Unity editor menu) +2. Click `Download the SDK` + +3. Import package in Unity + + - Assets—>Import package—>Custom Package (from the Unity editor menu) **OR** - * Double-click downloaded `.unityPackage` + - Double-click downloaded `.unityPackage` + +## Installation from Git (source) + +1. `git clone https://github.com/mapbox/mapbox-unity-sdk.git` +2. [Read about how the project is configured](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/README.md) and [learn how to contribute](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/CONTRIBUTING.md) +3. The actual Unity project is nested in the `sdkproject` directory + +## Configure your Mapbox API Token + +You need an [access token](https://www.mapbox.com/help/define-access-token) to use your Mapbox account's capabilities. + +- [Get a Mapbox API token and add it to your Unity project](01-mapbox-api-token.md) -## From Source +## Next Steps -* `git clone https://github.com/mapbox/mapbox-unity-sdk.git` +- Explore the [bundled Unity examples](03-examples.md) +- Learn about the [Map Factory Framework](06-map-factory-framework.md) +- Read the [Unity/C# API documentation](https://www.mapbox.com/mapbox-unity-sdk/api/) + +## Explore + +- Learn [how Mapbox works](https://www.mapbox.com/help/how-mapbox-works/) +- Check out [Mapbox and GIS termnology](https://www.mapbox.com/help/glossary/) +- Read general [Mapbox API documentation](https://www.mapbox.com/api-documentation/) +- Learn about [Mapbox Studio](https://www.mapbox.com/help/studio-manual/) +- [Create a custom raster style](https://www.mapbox.com/help/create-a-custom-style/) for use in Unity ## Issues -If you run into issues or have feedback, please contact us at https://www.mapbox.com/contact/ or check for issues in our repo: https://github.com/mapbox/mapbox-unity-sdk/issues. \ No newline at end of file +Before reporting issues or contacting support, please follow these steps: + +1. Check that you are using the latest version of the [Mapbox Unity SDK](05-changelog.md) +2. Read about [Known Issues](02-known-issues.md) +3. Check our [public respository for existing issues](https://github.com/mapbox/mapbox-unity-sdk/issues) + + + +If you still need help, please [contact support](https://www.mapbox.com/contact/) or [create an issue](https://github.com/mapbox/mapbox-unity-sdk/issues). \ No newline at end of file diff --git a/documentation/docs/images/favicon.ico b/documentation/docs/images/favicon.ico index e2e0b61f3..43ef9ab11 100644 Binary files a/documentation/docs/images/favicon.ico and b/documentation/docs/images/favicon.ico differ diff --git a/documentation/docs/images/mapbox-logo.png b/documentation/docs/images/mapbox-logo.png index 0f5692bc3..703c765c1 100644 Binary files a/documentation/docs/images/mapbox-logo.png and b/documentation/docs/images/mapbox-logo.png differ diff --git a/documentation/docs/index.md b/documentation/docs/index.md index d17cfae1f..1928922e7 100644 --- a/documentation/docs/index.md +++ b/documentation/docs/index.md @@ -1,22 +1,52 @@ -# Mapbox Unity SDK +--- +title: Welcome to Mapbox Unity SDK documentation! +documentType: index +--- -Welcome to the `Mapbox Unity SDK`! + -Check out these links to get started: +
+
+
+ Mapbox Unity SDK +
+
+ Version Notes|View in Github +
+
+ The Mapbox Unity SDK is a C#-based wrapper for Mapbox's location APIs. It allows Unity developers
to easily access and interact with our Maps, Geocoding, and Directions services from within the Unity 3D platform. +
+
+ Getting started + Get the SDK +
+
+
-* [Getting started](00-getting-started.md) -* [Mapbox API Token](01-mapbox-api-token.md) -* [Known issues](02-known-issues.md) -* [Examples](03-examples.md) -This SDK uses: -* `mapbox-sdk-cs` for interacting with the Mapbox API - * documentation: https://mapbox.github.io/mapbox-sdk-cs/ - * source: https://github.com/mapbox/mapbox-sdk-cs - * nuget: https://www.nuget.org/packages/MapboxSdkCs/ -* `vector-tile-cs` for parsing vector tiles - * source: https://github.com/mapbox/vector-tile-cs - * nuget: https://www.nuget.org/packages/Mapbox.VectorTile/ +
+
+
+
+

+Quick start links:
+

    +
  • [Getting started](00-getting-started.md)

  • +
  • [Mapbox API Token](01-mapbox-api-token.md)

  • +
  • [Known issues](02-known-issues.md)

  • +
  • [Examples](03-examples.md)

  • +
  • [API Documentation](api/)

  • +
+

+ +
+
+
+