Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion documentation/docfx_project/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,8 @@
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [
"default"
"default",
"template"
],
"postProcessors": [],
"noLangKeyword": false
Expand Down
85 changes: 85 additions & 0 deletions documentation/docfx_project/template/dashboard.html.liquid
Original file line number Diff line number Diff line change
@@ -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 -%}
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
{% include partials/head -%}
<body data-spy="scroll" data-target="#affix">
<style type="text/css">
#template-container {
display: flex;
flex-direction: row;
flex-wrap: wrap;
clear: both;
}
.template-item {
flex: 0 0 50%;
display: block;
padding: 16px;
}
.template-screenshot {
position: relative;
margin-bottom: 16px;
padding-top: 60%;
height: 0;
}
.template-screenshot-img {
position: absolute;
top: 0;
width: 100%;
height: auto;
}
.template-title {
font-weight: 600;
font-size: 1.1em;
}
</style>
<div id="wrapper">
<header>
{% include partials/navbar -%}
{% include partials/breadcrumb -%}
</header>
<div role="main" class="container body-content hide-when-search">
{% include partials/toc -%}
<div class="article row grid-right">
<span class="pull-right mobile-hide">
<a href="{{contributionLink}}" class="contribution-link">Add Your Own Template</a>
</span>
{{rawTitle}}
{{conceptual}}
{%- if templates -%}
<ul id="template-container">
{%- for template in templates -%}
<li class="template-item">
<div class="template-screenshot">
<img src= "{{template.thumbnail}}" class="template-screenshot-img"/>
</div>
<a class="template-title" href="{{template.homepage}}">{{template.name}}</a>
<p class="template-desc" >{{template.description}}</p>
{%- if template.usage -%}
<ul>
{%- if template.usage.init -%}
<li><span>Init:<code>{{template.usage.init | escape}}</code></span></li>
{%- endif -%}
{%- if template.usage.command -%}
<li><span>In command:<code>{{template.usage.command | escape}}</code></span></li>
{%- endif -%}
{%- if template.usage.config -%}
<li><span>In <c>docfx.json</c>:<code>{{template.usage.config | escape}}</code></span></li>
{%- endif -%}
</ul>
{%- endif -%}
</li>
{%- endfor -%}
</ul>
{%- endif -%}
</div>
</div>
{% include partials/footer -%}
</div>
{% include partials/scripts -%}
</body>
</html>
20 changes: 20 additions & 0 deletions documentation/docfx_project/template/index.html.tmpl
Original file line number Diff line number Diff line change
@@ -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)}}
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
{{>partials/head}}
<body data-spy="scroll" data-target="#affix">
<div id="wrapper">
<header>
{{>partials/navbar}}
</header>
{{{conceptual}}}
{{>partials/footer}}
</div>
{{>partials/scripts}}
</body>
</html>
151 changes: 151 additions & 0 deletions documentation/docfx_project/template/styles/main.css
Original file line number Diff line number Diff line change
@@ -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;
}
}
4 changes: 2 additions & 2 deletions documentation/docfx_project/toc.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
- name: API
- name: API Documentation
tocHref: api/toc.yml
topicHref: api/

- name: Documentation
- name: Tutorials & Guides
tocHref: ../docs/toc.yml
52 changes: 41 additions & 11 deletions documentation/docs/00-getting-started.md
Original file line number Diff line number Diff line change
@@ -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.
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).
Binary file modified documentation/docs/images/favicon.ico
Binary file not shown.
Binary file modified documentation/docs/images/mapbox-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading