├── .gitignore
├── LICENSE
├── Makefile
├── Procfile
├── README.md
├── SETUP.md
├── circle.yml
├── config
    ├── android.yml
    ├── cartography.yml
    ├── default.yml
    ├── elevation.yml
    ├── guides.yml
    ├── index.yml
    ├── ios.yml
    ├── libpostal.yml
    ├── mapzen-js.yml
    ├── metro-extracts.yml
    ├── mobility.yml
    ├── overview.yml
    ├── places.yml
    ├── search.yml
    ├── tangram.yml
    ├── terrain-tiles.yml
    └── vector-tiles.yml
├── deploy.sh
├── docs
    ├── guides
    │   ├── github-tutorial.md
    │   ├── images
    │   │   ├── create-new-file-button.png
    │   │   ├── edit-this-text-button.png
    │   │   ├── fork-repo-button.png
    │   │   ├── github-pages-source.png
    │   │   ├── index-file-commit-small.png
    │   │   ├── index-file-commit.png
    │   │   ├── open-pull-request-small.png
    │   │   ├── open-pull-request.png
    │   │   ├── pull-request-add-comment-small.png
    │   │   ├── pull-request-add-comment.png
    │   │   ├── pull-request-delete-branch.png
    │   │   ├── pull-request-page-small.png
    │   │   ├── pull-request-page.png
    │   │   ├── raw-button.png
    │   │   └── repository-settings-button.png
    │   ├── index.md
    │   ├── install-text-editor.md
    │   └── server-environment.md
    └── overview
    │   ├── account-settings.md
    │   ├── api-keys.md
    │   ├── billing.md
    │   ├── index.md
    │   ├── rate-limits.md
    │   └── support.md
├── extract-tarball-url.py
├── requirements.txt
├── run-checklist.py
├── runtime.txt
├── setup-redirects.py
├── setup-renames.py
├── src-index
    └── index.md
└── theme
    ├── base.html
    ├── breadcrumbs.html
    ├── common
        └── cta.html
    ├── css
        └── codehilite
        │   ├── default.css
        │   ├── mapzen.css
        │   └── monokai.css
    ├── js
        └── base.js
    ├── nav-sub.html
    ├── search-form.html
    ├── search-modal.html
    ├── toc-sub.html
    └── toc.html


/.gitignore:
--------------------------------------------------------------------------------
 1 | # Dependencies
 2 | env
 3 | 
 4 | # Generated files
 5 | dist/
 6 | src-*/
 7 | dist-*/
 8 | dist-*-mkdocs.yml
 9 | .sass-cache/
10 | theme/fragments/
11 | !src-index/
12 | venv/
13 | 
14 | # Python
15 | *.pyc
16 | *.egg-info/
17 | __pycache__
18 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2015 Mapzen
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 
23 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
  1 | # Source doc tarballs
  2 | TANGRAM = https://github.com/tangrams/tangram-docs/archive/gh-pages.tar.gz
  3 | EXTRACTS = https://github.com/mapzen/metro-extracts/archive/master.tar.gz
  4 | VALHALLA = https://github.com/valhalla/valhalla-docs/archive/master.tar.gz
  5 | VECTOR_TILES = https://api.github.com/repos/tilezen/vector-datasource/releases/latest
  6 | TERRAIN_TILES = https://api.github.com/repos/tilezen/joerd/releases/latest
  7 | SEARCH = https://github.com/pelias/pelias-doc/archive/master.tar.gz
  8 | ANDROID = https://github.com/mapzen/android/archive/master.tar.gz
  9 | IOS = https://github.com/mapzen/ios/archive/master.tar.gz
 10 | MAPZENJS = https://mapzen.com/js/docs.tar.gz
 11 | LIBPOSTAL = https://github.com/whosonfirst/go-whosonfirst-libpostal/archive/master.tar.gz
 12 | CARTOGRAPHY = https://github.com/tangrams/cartography-docs/archive/master.tar.gz
 13 | PLACES = https://github.com/whosonfirst/whosonfirst-www-api/archive/mapzen.tar.gz
 14 | 
 15 | SHELL := /bin/bash # required for OSX
 16 | PYTHONPATH := packages:$(PYTHONPATH)
 17 | 
 18 | all: dist
 19 | 
 20 | clean:
 21 | 	rm -rf dist theme/fragments
 22 | 	rm -rf src-android src-ios src-elevation src-mapzen-js src-metro-extracts \
 23 | 	       src-mobility src-search src-tangram src-terrain-tiles \
 24 | 	       src-vector-tiles src-libpostal src-cartography
 25 | 	rm -rf dist-android dist-ios dist-elevation dist-index dist-mapzen-js \
 26 | 	       dist-metro-extracts dist-mobility dist-search dist-tangram \
 27 | 	       dist-terrain-tiles dist-vector-tiles dist-libpostal dist-cartography
 28 | 	rm -rf dist-android-mkdocs.yml dist-ios-mkdocs.yml dist-elevation-mkdocs.yml \
 29 | 	       dist-index-mkdocs.yml dist-mapzen-js-mkdocs.yml \
 30 | 	       dist-metro-extracts-mkdocs.yml dist-mobility-mkdocs.yml \
 31 | 	       dist-search-mkdocs.yml dist-tangram-mkdocs.yml \
 32 | 	       dist-terrain-tiles-mkdocs.yml dist-vector-tiles-mkdocs.yml \
 33 | 	       dist-libpostal-mkdocs.yml dist-cartography-mkdocs.yml \
 34 | 	       dist-places-mkdocs.yml
 35 | 
 36 | # Get individual sources docs
 37 | src-tangram:
 38 | 	mkdir src-tangram
 39 | 	curl -sL $(TANGRAM) | tar -zxv -C src-tangram --strip-components=2 tangram-docs-gh-pages/pages
 40 | 
 41 | src-metro-extracts:
 42 | 	mkdir src-metro-extracts
 43 | 	curl -sL $(EXTRACTS) | tar -zxv -C src-metro-extracts --strip-components=2 metro-extracts-master/docs
 44 | 
 45 | src-vector-tiles:
 46 | 	mkdir src-vector-tiles
 47 | 	# Try with --wildcards for GNU tar, but fall back to BSD tar syntax for Mac.
 48 | 	curl -sL $(VECTOR_TILES) \
 49 | 	| ./extract-tarball-url.py \
 50 | 	| xargs curl -sL | ( \
 51 | 	    tar -zxv -C src-vector-tiles --strip-components=2 --exclude=README.md --wildcards '*/docs/' \
 52 | 	 || tar -zxv -C src-vector-tiles --strip-components=2 --exclude=README.md '*/docs/' \
 53 | 	    )
 54 | 
 55 | src-terrain-tiles:
 56 | 	mkdir src-terrain-tiles
 57 | 	# Try with --wildcards for GNU tar, but fall back to BSD tar syntax for Mac.
 58 | 	curl -sL $(TERRAIN_TILES) \
 59 | 	| ./extract-tarball-url.py \
 60 | 	| xargs curl -sL | ( \
 61 | 	    tar -zxv -C src-terrain-tiles --strip-components=2 --exclude=README.md --wildcards '*/docs/' \
 62 | 	 || tar -zxv -C src-terrain-tiles --strip-components=2 --exclude=README.md '*/docs/' \
 63 | 	    )
 64 | 
 65 | src-elevation:
 66 | 	mkdir src-elevation
 67 | 	curl -sL $(VALHALLA) | tar -zxv -C src-elevation --strip-components=2 valhalla-docs-master/elevation
 68 | 
 69 | src-mobility:
 70 | 	mkdir src-mobility
 71 | 	curl -sL $(VALHALLA) | tar -zxv -C src-mobility --strip-components=1 valhalla-docs-master
 72 | 
 73 | src-search:
 74 | 	mkdir src-search
 75 | 	curl -sL $(SEARCH) | tar -zxv -C src-search --strip-components=1 pelias-doc-master
 76 | 
 77 | src-android:
 78 | 	mkdir src-android
 79 | 	curl -sL $(ANDROID) | tar -zxv -C src-android --strip-components=2 android-master/docs
 80 | 
 81 | src-ios:
 82 | 	mkdir src-ios
 83 | 	curl -sL $(IOS) | tar -zxv -C src-ios --strip-components=2 ios-master/docs
 84 | 
 85 | src-mapzen-js:
 86 | 	mkdir src-mapzen-js
 87 | 	curl -sL $(MAPZENJS) | tar -zxv -C src-mapzen-js --strip-components=1 docs
 88 | 
 89 | src-libpostal:
 90 | 	mkdir src-libpostal
 91 | 	curl -sL $(LIBPOSTAL) | tar -zxv -C src-libpostal --strip-components=2 go-whosonfirst-libpostal-master/docs
 92 | 
 93 | src-places:
 94 | 	mkdir src-places
 95 | 	curl -sL $(PLACES) | tar -zxv -C src-places --strip-components=2 whosonfirst-www-api-mapzen/docs
 96 | 
 97 | src-cartography:
 98 | 	mkdir src-cartography
 99 | 	curl -sL $(CARTOGRAPHY) | tar -zxv -C src-cartography --strip-components=1 cartography-docs-master
100 | 
101 | src-overview:
102 | 	cp -r docs/overview src-overview
103 | 
104 | src-guides:
105 | 	cp -r docs/guides src-guides
106 | 
107 | # Retrieve style guide
108 | theme/fragments:
109 | 	mkdir -p theme/fragments
110 | 	curl -sL 'https://mapzen.com/site-fragments/navbar.html' -o theme/fragments/global-nav.html
111 | 	curl -sL 'https://mapzen.com/site-fragments/footer.html' -o theme/fragments/global-footer.html
112 | 
113 | # Build Tangram, Metro Extracts, Vector Tiles, Elevation, Search, Mobility,
114 | # Android, iOS, Mapzen JS, Terrain Tiles, Who's On First and Overview docs.
115 | # Uses GNU Make pattern rules:
116 | # https://www.gnu.org/software/make/manual/html_node/Pattern-Examples.html
117 | dist-%: src-% theme/fragments
118 | 	anyconfig_cli ./config/default.yml ./config/$*.yml --merge=merge_dicts --output=./dist-$*-mkdocs.yml
119 | 	./setup-renames.py ./dist-$*-mkdocs.yml
120 | 	mkdocs build --config-file ./dist-$*-mkdocs.yml --clean
121 | 	./setup-redirects.py ./dist-$*-mkdocs.yml /documentation/$*/
122 | 
123 | # Build index page
124 | dist-index: theme/fragments
125 | 	anyconfig_cli ./config/default.yml ./config/index.yml --merge=merge_dicts --output=./dist-index-mkdocs.yml
126 | 	mkdocs build --config-file ./dist-index-mkdocs.yml --clean
127 | 	./setup-redirects.py ./dist-index-mkdocs.yml /documentation/
128 | 	cp dist-index/index.html dist-index/next.html
129 | 
130 | dist: dist-tangram dist-metro-extracts dist-vector-tiles dist-search dist-elevation dist-android dist-ios dist-mapzen-js dist-overview dist-guides dist-index dist-mobility dist-terrain-tiles dist-libpostal dist-places dist-cartography
131 | 	mkdir dist
132 | 	ln -s ../dist-tangram dist/tangram
133 | 	ln -s ../dist-metro-extracts dist/metro-extracts
134 | 	ln -s ../dist-vector-tiles dist/vector-tiles
135 | 	ln -s ../dist-terrain-tiles dist/terrain-tiles
136 | 	ln -s ../dist-search dist/search
137 | 	ln -s ../dist-elevation dist/elevation
138 | 	ln -s ../dist-mobility dist/mobility
139 | 	ln -s ../dist-android dist/android
140 | 	ln -s ../dist-ios dist/ios
141 | 	ln -s ../dist-mapzen-js dist/mapzen-js
142 | 	ln -s ../dist-overview dist/overview
143 | 	ln -s ../dist-guides dist/guides
144 | 	ln -s ../dist-libpostal dist/libpostal
145 | 	ln -s ../dist-cartography dist/cartography
146 | 	ln -s ../dist-places dist/places
147 | 	rsync -urv --ignore-existing dist-index/ dist/
148 | 
149 | serve:
150 | 	@mkdocs serve
151 | 
152 | .PHONY: all clean serve
153 | 


--------------------------------------------------------------------------------
/Procfile:
--------------------------------------------------------------------------------
1 | 
2 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Mapzen documentation
 2 | 
 3 | This repository contains the configuration files and tools used to build Mapzen's documentation site [mapzen.com/documentation](https://mapzen.com/documentation/). 
 4 | 
 5 | The documentation is built with an open-source Python tool called [MkDocs](http://www.mkdocs.org/), which formats GitHub markdown files in to a static, HTML website. Note that while MkDocs reads just one source, Mapzen has enhanced it to integrate multiple repositories. There have been additional enhancements to support URL redirects and renaming files in the output help. You can read more about this process in the [blog post](https://mapzen.com/blog/doc-site/).
 6 | 
 7 | As long as a markdown file is listed in the build configuration, changes in the source files in the GitHub branch that is being pulled into the help (typically, the master branch) appear automatically on https://mapzen.com/documentation. This is through continuous integration processes that run in the source respositories and in this one.
 8 | 
 9 | ## Source file locations
10 | 
11 | The source files to build Mapzen's documentation may be found in separate documentation repositories in a GitHub organization, as a documentation folder in a project's repository, or within this repository. Getting changes onto the documentation site may require the files be on a certain branch or in a release.
12 | 
13 | |                           Documentation section                       | Source location | Branch name or release  |
14 | |----------------------------------------------------------|---------------------|----------|
15 | | [Overview](http://www.mapzen.com/documentation/overview) | https://github.com/mapzen/mapzen-docs-generator/tree/master/docs  | Master  |
16 | | [mapzen.js](https://mapzen.com/documentation/mapzen-js/)  | https://github.com/mapzen/mapzen.js/tree/master/docs  | Latest release  |
17 | | [Tangram](https://mapzen.com/documentation/tangram/) | https://github.com/tangrams/tangram-docs | gh-pages   |
18 | | [Vector tiles](https://mapzen.com/documentation/vector-tiles/)  | https://github.com/tilezen/vector-datasource/tree/master/docs  | Latest release |
19 | | [Search](https://mapzen.com/documentation/search/)  | https://github.com/pelias/pelias-doc  | Master  |
20 | | [Mobility](https://mapzen.com/documentation/mobility/)  | https://github.com/valhalla/valhalla-docs  | Master |
21 | | [Metro Extracts](https://mapzen.com/documentation/metro-extracts/)  | https://github.com/mapzen/metro-extracts/tree/master/docs  | Master |
22 | | [Terrain tiles](https://mapzen.com/documentation/terrain-tiles/)  | https://github.com/tilezen/joerd  | Latest release  |
23 | | [Elevation](https://mapzen.com/documentation/elevation/) | https://github.com/valhalla/valhalla-docs  | Master |
24 | | [Android SDK](https://mapzen.com/documentation/android/) | https://github.com/mapzen/android/tree/master/docs | Master |
25 | | [iOS SDK](https://mapzen.com/documentation/ios/) | https://github.com/mapzen/ios/blob/master/docs | Master |
26 | | [Address parsing/libpostal](https://mapzen.com/documentation/libpostal/) | https://github.com/whosonfirst/go-whosonfirst-libpostal/blob/master/docs | Master |
27 | | [Who's On First](https://mapzen.com/documentation/wof/) | https://github.com/whosonfirst/whosonfirst-www-api/tree/master/docs | Master |
28 | | [Cartography](https://mapzen.com/documentation/cartography/) | https://github.com/tangrams/cartography-docs/ | Master |
29 | 
30 | ## Build locally
31 | 
32 | If you need to build the documentation locally for testing, clone this repository and open a terminal window to the `documentation` folder.
33 | 
34 | On a Mac, assuming you have [Homebrew](http://brew.sh) and 
35 | [Python 3](https://docs.python.org/3/using/mac.html) installed, and a local
36 | checkout of this repository:
37 | 
38 | ```shell
39 | # Prepare virtualenv and install local dependencies
40 | virtualenv -p python3 venv
41 | source venv/bin/activate
42 | pip install -Ur requirements.txt
43 | 
44 | # Get all the sources and build all the documentation
45 | make
46 | 
47 | # Use `make clean all` for a fresh build
48 | 
49 | # Local preview
50 | python -m http.server 8000
51 | open http://localhost:8000/dist/
52 | ```
53 | 
54 | Run `make clean all` to build a clean copy of the documentation. This command deletes the previous build and makes new files.
55 | 
56 | You may be able to build one section of the documentation using `make clean dist-{projectname}`, such as `make clean dist-tangram`.
57 | 


--------------------------------------------------------------------------------
/SETUP.md:
--------------------------------------------------------------------------------
  1 | # Set up and build documentation
  2 | 
  3 | ## Follow the writing instructions
  4 | 
  5 | - Follow the guidelines of the [writing style guide](https://github.com/mapzen/styleguide/tree/master/src/site/guides) when it comes to writing technical documentation.
  6 | - Include an `index.md` file at the root folder of your documentation. (Note: [MkDocs will allow this to be customized in the future.](https://github.com/mkdocs/mkdocs/issues/608))
  7 | - Start each page with a top-level heading with one `#` symbol, except for the index.md. The home page should not have a title because it would most likely duplicate the banner on the page.
  8 | - Follow the [Markdown formatting guide](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
  9 | - Add blank lines between different blocks of content: before and after bulleted lists, numbered lists, code blocks, images, and so on.
 10 | - If a code block or image is supposed to be part of a list, remember the blank lines before and after, and also indent it four spaces. Using or mixing tabs might cause problems. Python Markdown is a lot pickier about this than GitHub-flavored Markdown, causing lists to nest improperly or break numbering altogether.
 11 | 
 12 | ## Add a new section to the documentation
 13 | 
 14 | Adding an entirely new section of the help has many factors, ranging from design decisions on the mapzen.com website to the mechanics of building the help. In general, there are four files that you need to update to do this. You can often copy, paste, and modify existing files to understand what needs to be updated to add the new section.
 15 | 
 16 | 1. Add an entry to https://github.com/mapzen/documentation/tree/master/src-index to update the index file that is the landing page for the documentation.
 17 | 2. Add a new config `.yml` file to https://github.com/mapzen/documentation/tree/master/config. This builds the table of contents and sets the links to the source files so the `Edit this page on GitHub` links work properly (these allow users to go directly to the source file to propose edits).
 18 | 3. Update the Makefile in https://github.com/mapzen/documentation/blob/master/Makefile that pulls together all resources for the help.
 19 | 4. Update the automated test at https://github.com/mapzen/documentation/blob/master/run-checklist.py.
 20 | 
 21 | If you are removing sections from the help, you will need to consider adding URL redirects to the `index.yml` file.
 22 | 
 23 | ## Add an entry to the documentation table of contents
 24 | 
 25 | To display on the documentation site, you need to add a topic to a configuration file. Otherwise, the topic exists only in the repository. It is fine to have topics in the repository that are not in the help system, as long as you know that is happening.
 26 | 
 27 | You need to update the config.yml file to add a topic, remove one, or rename it in the table of contents.
 28 | 
 29 | 1. Go to https://github.com/mapzen/documentation/tree/master/config
 30 | 2. Find the .yml file for your section of help. For example, Mapzen Mobility can be found in mobility.yml.
 31 | 3. Under `pages:`, make the change to the table of contents. The topic in the `Home:` position should always be only `index.md` (under MkDocs rules). Add topics by including a heading, contained in single quotation mark, followed by a colon and the name of the md file. For example, `'API reference': 'api-reference.md'`
 32 | 4. You can add nesting in the table of contents by indenting the lines underneath the heading.
 33 | 
 34 | ```json
 35 | - Concept overviews:
 36 |   - 'The Scene file': 'Scene-file.md'
 37 | ```
 38 | 
 39 | File names are case-sensitive, so 'Scene-file.md' is different from 'scene-file.md'. The file name in the config file must exactly match the source file, or else you will get a build error.
 40 | 
 41 | ### Preview content changes that are in a branch
 42 | 
 43 | If you've created a pull request in the documentation repository, and your content changes are in the branch that the help is built from (usually, master), you can view changes at [precog.mapzen.com/mapzen/documentation/](precog.mapzen.com/mapzen/documentation/). 
 44 | 
 45 | If the content changes are in a different branch, you need to make temporary changes to the build process to locate your branch. 
 46 | 
 47 | 1. Create a branch in the `documentation` repository.
 48 | 1. Open the Makefile
 49 | 2. In another tab, open the latest commit on the branch you're working on in the particular project repository
 50 | 3. Copy the full commit ID
 51 | 4. In the Makefile, edit the URL and replace the phrase (typically, 'master') before .tar.gz with the commit ID, for example:
 52 | 
 53 | `EXTRACTS = https://github.com/mapzen/metro-extracts/archive/master.tar.gz --> EXTRACTS = https://github.com/mapzen/metro-extracts/archive/2d3ef32e1a6fc51be6908968e32902a04a016dee.tar.gz`
 54 | 
 55 | Note: If you are modifying the `VALHALLA` section, you will need to add a variable for it because the elevation documentation will break. 
 56 | 
 57 | ## Add URL redirects when you rename or move files
 58 | 
 59 | Mapzen wrote some additional Python code to enable URLs to forward when files are renamed or moved. For example, the existing Turn-by-Turn, Optimized Route, and Matrix sections of the help were grouped under a Mobility section when they were packaged into a product called Mapzen Mobility. Because adding mobility changed the URLs, redirects allowed the previous topics to be found in the new help.
 60 | 
 61 | For example, https://mapzen.com/documentation/turn-by-turn/api-reference/ redirects to https://mapzen.com/documentation/mobility/turn-by-turn/api-reference/ (note the mobility in the URL).
 62 | 
 63 | You will also need to do this when a file is removed or renamed in GitHub, and it has existed long enough that users may have bookmarked it or it can be found through search engines.
 64 | 
 65 | 1. Go to https://github.com/mapzen/mapzen-docs-generator/tree/master/config
 66 | 2. Find the .yml file for your section of help. For example, Mapzen Mobility can be found in mobility.yml.
 67 | 3. Look for a section named `mz:redirects:`. If one is not present, add it after the `pages:` section.
 68 | 4. Add a new line underneath, indent, and add the portion of the current URL to redirect, followed by a colon and the new URL.
 69 | 
 70 | Here is a sample from the mobility.yml.
 71 | 
 72 | ```
 73 | mz:redirects:
 74 |   'turn-by-turn': 'turn-by-turn/api-reference'
 75 |   'matrix': 'matrix/api-reference'
 76 |   'optimized': 'optimized/api-reference'
 77 | ```
 78 | 
 79 | Behind the scenes, this calls setup-redirects.py during the build process.
 80 | 
 81 | The base URL for all help is https://mapzen.com/documentation.
 82 | This means that the base URL + left part of the colon is https://mapzen.com/documentation/turn-by-turn.
 83 | 
 84 | When the script runs, the URL will redirect to the base URL + this section name from the config file (/mobility/) + the right side of the colon. This forms https://mapzen.com/documentation/mobility/turn-by-turn/api-reference.
 85 | 
 86 | Similarly, for the `matrix` entry, https://mapzen.com/documentation/matrix will redirect to https://mapzen.com/documentation/mobility/matrix/api-reference.
 87 | 
 88 | Note: you must use the redirects functionality anytime you are adding topics that fall under the mobility/turn-by-turn section of help because it takes on a different URL structure than the GitHub repository.
 89 | 
 90 | Note: if you completely remove a section from the help, you should put your `mz:redirects` in the `index.yml` file. For example, the `turn-by-turn.yml` file was deleted during a product reorganization process, so redirects from that section of help are in `index.yml`.
 91 | 
 92 | ## Use a URL structure different from the source file organization
 93 | 
 94 | MkDocs uses the exact file name and folder structure from the folder repository to build the URL for the help. This means that a file called `map_basics.md` becomes `/map_basics` with an underscore in the output documentation, when the URLs should ideally only have hyphens.
 95 | 
 96 | If you group markdown files in a folder in GitHub, the files will also have this structure in the URL. For example, if you have a folder called `api-reference-docs` with a file in it called `map-basics.md`, the output URL will include `api-reference-docs/map-basics`. In some cases, this adds unnecessary complexity and inconsistency in the URLs.
 97 | 
 98 | The simplest way around this is to rename or move the files in GitHub. When changing the source does not make sense, use the functions in the help build process.
 99 | 
100 | 1. Go to https://github.com/mapzen/mapzen-docs-generator/tree/master/config
101 | 2. Find the .yml file for your section of help. For example, Mapzen Mobility can be found in mobility.yml.
102 | 3. Look for a section named `mz:renames:`. If one is not present, add it before the `pages:` section.
103 | 4. Add a new line underneath, indent, and add the portion of the current URL to redirect, followed by a colon and the new path or filename.
104 | 5. In the `pages:` section, use the new name of the file.
105 | 
106 | Here is a sample from the mobility.yml.
107 | 
108 | ```
109 | mz:renames:
110 |   'optimized_route/api-reference.md': 'optimized/api-reference.md'
111 |   'api-reference.md': 'turn-by-turn/api-reference.md'
112 | ```
113 | 
114 | When the script runs, it will look in the GitHub source files for a folder named `optimized_route` (note the underscore) and a file in it called `api-reference.md`. It will then output to a temporary location during the build process a folder called `optimized` with the file in it still named `api-reference.md`. If you needed to rename the file, you could do that, too.
115 | 
116 | In the second entry, it will look at the root level of the GitHub source for a file called `api-reference.md` and output it to a folder named `turn-by-turn`.
117 | 
118 | ## Change the documentation source location permanently
119 | 
120 | If you move content or rename a repository, you need to update the source location to make the documentation build succeed and see your changes.
121 | 
122 | 1. Update the project configuration file. This is located at `config/project-name.yml` file. Look for the `extra` key and find or create, one level in, the `docs_base_url` key. This is used to build the `Edit this page on GitHub` links at the bottom of each page. It will look something like this:
123 | 
124 |     ```yml
125 |     extra:
126 |       docs_base_url: https://github.com/mapzen/mapzen-docs/tree/master/metro-extracts
127 |     ```
128 | 
129 | 2. Update the repository path in the Makefile.
130 | 3. Create redirects, if necessary. Sometimes you have to change names for the files or move files into other folders, or you delete a file. You should make a redirect link so users can find the new topic. If you need to create a different path in the documentation output than the file name or folder system, consider whether you should make these changes in the GitHub repository first.
131 | 
132 | ## Makefile reference
133 | 
134 | The Makefile collects and builds the documentation. Here are the general steps it takes. 
135 | 
136 | - It first retrieves the source documentation file, which is available from GitHub inside a pre-packaged archive with the extension `tar.gz`. 
137 |     
138 |     `TANGRAM = https://github.com/tangrams/tangram-docs/archive/gh-pages.tar.gz`
139 |     
140 | - It uncompresses the file, with a line further down in the Makefile that looks something like this. This will extract the files into the `src/project-name` directory, which makes them available to mkdocs. 
141 | 
142 |     `curl -sL $(TANGRAM) | tar -zxv -C src-tangram --strip-components=2 tangram-docs-gh-pages/pages`
143 |     
144 | You can use this line to change the branch used as the source of the documentation with these lines, which can be handy for testing purposes. This is accomplished by replacing `gh-pages` with the name of another branch. Note that you'll need to convert any slashes in the branch name to dashes. For example, if your repo name is `tangram-docs` and your branch name is `cleanup`, the reference in the `curl` command will look like `tangram-docs-cleanup`, and the full command will be:
145 | 
146 | `curl -sL $(TANGRAM) | tar -zxv -C src-tangram --strip-components=2 tangram-docs-cleanup/pages`
147 | 


--------------------------------------------------------------------------------
/circle.yml:
--------------------------------------------------------------------------------
 1 | machine:
 2 |   python:
 3 |     version: 3.4.3
 4 | 
 5 | dependencies:
 6 |   override:
 7 |     - sudo apt-get update -y
 8 |     - sudo apt-get install -y curl
 9 |     - pip install -r requirements.txt
10 | 


--------------------------------------------------------------------------------
/config/android.yml:
--------------------------------------------------------------------------------
 1 | site_name: Mapzen Android SDK
 2 | docs_dir: src-android
 3 | site_dir: dist-android
 4 | 
 5 | pages:
 6 |   - Home: index.md
 7 |   - 'Installation': 'installation.md'
 8 |   - 'Get started': 'getting-started.md'
 9 |   - 'Position, rotation, and zoom': 'basic-functions.md'
10 |   - 'Add features': 'features.md'
11 |   - 'Switching styles': 'styles.md'
12 |   - 'Gesture responders': 'gesture-responders.md'
13 |   - 'Location services': 'location-services.md'
14 |   - LOST:
15 |     - 'Get started': 'lost/get-started.md'
16 |     - 'Last known location': 'lost/last-known-location.md'
17 |     - 'Receive location updates': 'lost/location-updates.md'
18 |     - 'Mock locations & routes': 'lost/mock-locations-routes.md'
19 |     - 'Change location settings': 'lost/location-settings.md'
20 |     - 'Create and Monitor geofences': 'lost/geofences.md'
21 |   - Mapzen Places for Android:
22 |     - 'Overview': 'places.md'
23 |     - 'Autocomplete interface': 'autocomplete-ui.md'
24 |     - 'GeoData API': 'geodata-api.md'
25 |   - 'Mapzen Search for Android': 'search.md'
26 |   - 'Mapzen Turn-by-Turn for Android': 'turn-by-turn.md'
27 |   - 'Javadoc': 'javadoc.md'
28 | 
29 | mz:redirects:
30 |   'markers': 'add-features'
31 |   'polylines': 'add-features'
32 |   'polygons': 'add-features'
33 |   'current-location': 'location-services'
34 | 
35 | extra:
36 |   site_subtitle: 'A thin wrapper that packages up everything you need to use Mapzen services in your Android applications.'
37 |   project_repo_url: https://github.com/mapzen/android
38 |   docs_base_url: https://github.com/mapzen/android/tree/master/docs
39 | 


--------------------------------------------------------------------------------
/config/cartography.yml:
--------------------------------------------------------------------------------
 1 | site_name: Cartography
 2 | docs_dir: src-cartography
 3 | site_dir: dist-cartography
 4 | 
 5 | pages:
 6 |   - Home: index.md
 7 |   - 'Get started': 'get-started.md'
 8 |   - 'Basemap styles': 'styles.md'
 9 |   - 'Themes': 'themes.md'
10 |   - 'Icons': 'icons.md'
11 |   - 'API reference': 'api-reference.md'
12 |   - 'Migration guide': 'migration-guide.md'
13 |   - 'Versioning': 'versioning.md'
14 | 
15 | extra:
16 |   site_subtitle: 'Get everything you need to use Mapzen basemaps and icons in your applications.'
17 |   project_repo_url: https://github.com/tangrams/cartography-docs
18 |   docs_base_url: https://github.com/tangrams/cartography-docs/tree/master
19 | 


--------------------------------------------------------------------------------
/config/default.yml:
--------------------------------------------------------------------------------
 1 | #   !! DO NOT DELETE THIS FILE !!
 2 | #
 3 | # This sets default settings for MkDocs.
 4 | # Each individual project settings will be merged with this file.
 5 | #
 6 | # -----------------------------------------------------------------------------
 7 | 
 8 | site_name: Mapzen documentation
 9 | repo_url: https://github.com/mapzen/mapzen-docs-generator
10 | remote_branch: master
11 | # google_analytics: ['UA-47035811-1', 'mapzen.com']
12 | theme: mkdocs
13 | theme_dir: theme
14 | include_nav: true
15 | include_next_prev: true
16 | extra_css: [css/codehilite/mapzen.css]
17 | 
18 | # Determines if a broken link to a page within the documentation is considered
19 | # a warning or an error (link to a page not listed in the pages setting). Set
20 | # to true to halt processing when a broken link is found, false prints a warning.
21 | strict: true
22 | 
23 | markdown_extensions:
24 |   - smarty
25 |   - toc:
26 |       permalink: ' ' # Blank space; this marker is styled in CSS.
27 |   - sane_lists
28 |   - nl2br
29 |   - outline
30 |   - codehilite
31 |   # Set of PyMdown extensions to flesh out GFM-mimicry
32 |   - pymdownx.betterem:
33 |       smart_enable: all
34 |   - pymdownx.githubemoji
35 |   - pymdownx.magiclink
36 |   - pymdownx.superfences
37 |   - pymdownx.tasklist
38 |   - pymdownx.tilde
39 | 
40 | # Extra variables for templates
41 | extra:
42 |   site_subtitle: Placeholder subtitle.
43 |   project_repo_url: https://github.com/mapzen/mapzen-docs-generator/
44 |   # This is used to build the "edit in GitHub" links.
45 |   docs_base_url: https://github.com/mapzen/mapzen-docs-generator/tree/master/
46 |   exclude_home_contents_in_toc: true
47 | 


--------------------------------------------------------------------------------
/config/elevation.yml:
--------------------------------------------------------------------------------
 1 | site_name: Elevation Service
 2 | docs_dir: src-elevation
 3 | site_dir: dist-elevation
 4 | extra_css: [css/codehilite/mapzen.css]
 5 | 
 6 | pages:
 7 |   - Home: index.md
 8 |   - 'Elevation service': 'elevation-service.md'
 9 | 
10 | extra:
11 |   site_subtitle: 'Take your map to new heights.'
12 |   project_repo_url: https://github.com/valhalla/skadi
13 |   docs_base_url: https://github.com/valhalla/valhalla-docs/tree/master/elevation
14 | 


--------------------------------------------------------------------------------
/config/guides.yml:
--------------------------------------------------------------------------------
 1 | site_name: Developer Guides
 2 | docs_dir: src-guides
 3 | site_dir: dist-guides
 4 | 
 5 | pages:
 6 |   - Home: 'index.md'
 7 |   - Text editors: 'install-text-editor.md'
 8 |   - Server environment: 'server-environment.md'
 9 |   - GitHub tutorial: 'github-tutorial.md'
10 | 
11 | extra:
12 |   site_subtitle: 'Set up your development environment with these how-to topics'
13 |   project_repo_url: https://github.com/mapzen/mapzen-docs-generator
14 |   docs_base_url: https://github.com/mapzen/mapzen-docs-generator/tree/master/docs/guides
15 | 


--------------------------------------------------------------------------------
/config/index.yml:
--------------------------------------------------------------------------------
 1 | docs_dir: src-index
 2 | site_dir: dist-index
 3 | 
 4 | pages:
 5 |   - Home: index.md
 6 | 
 7 | mz:redirects:
 8 |   'matrix': 'mobility/matrix/api-reference'
 9 |   'matrix/api-reference': 'mobility/matrix/api-reference'
10 |   'optimized': 'mobility/optimized/api-reference'
11 |   'optimized/api-reference': 'mobility/optimized/api-reference'
12 |   'turn-by-turn': 'mobility/turn-by-turn'
13 |   'turn-by-turn/api-reference': 'mobility/turn-by-turn/api-reference'
14 |   'turn-by-turn/add-routing-to-a-map': 'mobility/turn-by-turn/add-routing-to-a-map'
15 |   'turn-by-turn/terminology': 'mobility/terminology'
16 |   'turn-by-turn/decoding': 'mobility/decoding'
17 |   'wof': 'places'
18 |   'wof/formats': 'places/formats'
19 |   'wof/methods': 'places/methods'
20 |   'wof/pagination': 'places/pagination'
21 |   'wof/errors': 'places/errors'
22 | 
23 | extra:
24 |   layout: raw-page
25 | 


--------------------------------------------------------------------------------
/config/ios.yml:
--------------------------------------------------------------------------------
 1 | site_name: Mapzen iOS SDK
 2 | docs_dir: src-ios
 3 | site_dir: dist-ios
 4 | 
 5 | pages:
 6 |   - Home: index.md
 7 |   - 'Installation': 'installation.md'
 8 |   - 'Get started': 'getting-started.md'
 9 |   - 'Position, rotation, and zoom': 'basic-functions.md'
10 |   - 'Add features': 'features.md'
11 |   - 'Switching styles': 'styles.md'
12 |   - 'Gestures': 'gesture-delegates.md'
13 |   - 'Location Services': 'location-services.md'
14 |   - 'Mapzen Places for iOS': 'places.md'
15 |   - 'Mapzen Search for iOS': 'search.md'
16 |   - 'Mapzen Turn-by-Turn for iOS': 'turn-by-turn.md'
17 |   - 'Documentation': 'documentation.md'
18 | 
19 | extra:
20 |   site_subtitle: 'A thin wrapper that packages up everything you need to use Mapzen services in your iOS applications.'
21 |   project_repo_url: https://github.com/mapzen/ios
22 |   docs_base_url: https://github.com/mapzen/ios/tree/master/docs
23 | 


--------------------------------------------------------------------------------
/config/libpostal.yml:
--------------------------------------------------------------------------------
 1 | site_name: Address Parsing
 2 | docs_dir: src-libpostal
 3 | site_dir: dist-libpostal
 4 | extra_css: [css/codehilite/mapzen.css]
 5 | 
 6 | pages:
 7 |   - Home: index.md
 8 | 
 9 | extra:
10 |   site_subtitle: 'Parse and expand address data with the libpostal engine.'
11 |   project_repo_url: https://github.com/whosonfirst/go-whosonfirst-libpostal
12 |   docs_base_url: https://github.com/whosonfirst/go-whosonfirst-libpostal/blob/master/docs
13 | 


--------------------------------------------------------------------------------
/config/mapzen-js.yml:
--------------------------------------------------------------------------------
 1 | site_name: Mapzen JavaScript SDK
 2 | docs_dir: src-mapzen-js
 3 | site_dir: dist-mapzen-js
 4 | 
 5 | pages:
 6 |   - Home: index.md
 7 |   - 'Get started': 'get-started.md'
 8 |   - 'API reference': 'api-reference.md'
 9 |   - 'Geocoder': 'search.md'
10 |   - 'Routing': 'routing.md'
11 | 
12 | extra:
13 |   site_subtitle: 'Get everything you need to use Mapzen services in your web applications.'
14 |   project_repo_url: https://github.com/mapzen/mapzen.js
15 |   docs_base_url: https://github.com/mapzen/mapzen.js/tree/master/docs
16 | 


--------------------------------------------------------------------------------
/config/metro-extracts.yml:
--------------------------------------------------------------------------------
 1 | site_name: Metro Extracts
 2 | docs_dir: src-metro-extracts
 3 | site_dir: dist-metro-extracts
 4 | 
 5 | pages:
 6 |   - Home: index.md
 7 |   - 'Tutorial': 'tutorial.md'
 8 |   - 'Custom extracts': 'custom-extracts.md'
 9 |   - 'File formats': 'file-format.md'
10 | 
11 | mz:redirects:
12 |   'overview': '.'
13 |   'walkthrough': 'tutorial'
14 | 
15 | extra:
16 |   site_subtitle: Download city-sized portions of OpenStreetMap data in a variety of formats.
17 |   project_repo_url: https://github.com/mapzen/metro-extracts
18 |   docs_base_url: https://github.com/mapzen/metro-extracts/tree/master/docs
19 |   exclude_home_contents_in_toc: false
20 | 


--------------------------------------------------------------------------------
/config/mobility.yml:
--------------------------------------------------------------------------------
 1 | site_name: Mapzen Mobility
 2 | docs_dir: src-mobility
 3 | site_dir: dist-mobility
 4 | 
 5 | pages:
 6 |   - Home: index.md
 7 |   - 'Glossary': 'terminology.md'
 8 |   - Turn-by-Turn:
 9 |     - 'Overview': 'turn-by-turn/overview.md'
10 |     - 'API reference': 'turn-by-turn/api-reference.md'
11 |     - 'Tutorial': 'turn-by-turn/add-routing-to-a-map.md'
12 |   - 'Optimized route': 'optimized/api-reference.md'
13 |   - 'Time-Distance Matrix': 'matrix/api-reference.md'
14 |   - 'Isochrone': 'isochrone/api-reference.md'
15 |   - 'Map Matching': 'map-matching/api-reference.md'
16 |   - 'Mobility Explorer':
17 |     - 'Overview': 'explorer/overview.md'
18 |     - 'Explore transit': 'explorer/explore-transit.md'
19 |     - 'Generate isochrones': 'explorer/isochrones.md'
20 |     - 'Match GPS locations to a route': 'explorer/map-matching.md'
21 |     - 'Tutorial': 'explorer/tutorial.md'
22 |   - 'Reference':
23 |     - 'Speeds': 'speeds.md'
24 |     - 'Decode a route shape': 'decoding.md'
25 |   - 'Release notes': 'release-notes.md'
26 | 
27 | mz:redirects:
28 |   'turn-by-turn': 'turn-by-turn/api-reference'
29 |   'matrix': 'matrix/api-reference'
30 |   'optimized': 'optimized/api-reference'
31 |   'isochrone': 'isochrone/api-reference.md'
32 |   'map-matching': 'map-matching/api-reference.md'
33 | 
34 | extra:
35 |   site_subtitle: 'Add routing and navigation to your web and mobile apps.'
36 |   project_repo_url: https://github.com/valhalla/
37 |   docs_base_url: https://github.com/valhalla/valhalla-docs/tree/master
38 | 


--------------------------------------------------------------------------------
/config/overview.yml:
--------------------------------------------------------------------------------
 1 | site_name: Get started
 2 | docs_dir: src-overview
 3 | site_dir: dist-overview
 4 | 
 5 | pages:
 6 |   - 'Home': index.md
 7 |   - 'Account settings': 'account-settings.md'
 8 |   - 'Billing information': 'billing.md'
 9 |   - 'API keys': 'api-keys.md'
10 |   - 'Rate limits': 'rate-limits.md'
11 |   - 'Support': 'support.md'
12 | 
13 | # mz:redirects:
14 | #  'overview/#rate-limits': 'overview/rate-limits'
15 | 
16 | extra:
17 |   site_subtitle: Get started developing on the Mapzen platform by setting up your account, API keys, and billing information.
18 |   project_repo_url: https://github.com/mapzen/mapzen-docs-generator
19 |   docs_base_url: https://github.com/mapzen/mapzen-docs-generator/tree/master/docs/overview/
20 |   exclude_home_contents_in_toc: false
21 | 


--------------------------------------------------------------------------------
/config/places.yml:
--------------------------------------------------------------------------------
 1 | site_name: Mapzen Places
 2 | docs_dir: src-places
 3 | site_dir: dist-places
 4 | 
 5 | pages:
 6 |  - Home: index.md
 7 |  - 'Formats': 'formats.md'
 8 |  - 'Methods': 'methods.md'
 9 |  - 'Pagination': 'pagination.md'
10 |  - 'Error codes': 'errors.md'
11 | 
12 | extra:
13 |  site_subtitle: "Get administrative boundaries and hierarchies, neighbourhoods, postal codes, venues, and more."
14 |  project_repo_url: https://github.com/whosonfirst/whosonfirst-www-api
15 |  docs_base_url: https://github.com/whosonfirst/whosonfirst-www-api/tree/mapzen/docs
16 |  exclude_home_contents_in_toc: false
17 | 


--------------------------------------------------------------------------------
/config/search.yml:
--------------------------------------------------------------------------------
 1 | site_name: Mapzen Search
 2 | docs_dir: src-search
 3 | site_dir: dist-search
 4 | 
 5 | pages:
 6 |   - Home: index.md
 7 |   - 'Glossary': 'glossary.md'
 8 |   - 'Search': 'search.md'
 9 |   - 'Reverse geocoding': 'reverse.md'
10 |   - 'Autocomplete': 'autocomplete.md'
11 |   - 'Place': 'place.md'
12 |   - 'Structured geocoding': 'structured-geocoding.md'
13 |   - 'Addresses': 'addresses.md'
14 |   - 'API responses': 'response.md'
15 |   - 'Data sources': 'data-sources.md'
16 |   - 'Languages': 'language-codes.md'
17 |   - 'Common workflows': 'search-workflows.md'
18 |   - 'HTTP status codes': 'http-status-codes.md'
19 |   - 'Load data from the browser': 'use-cors.md'
20 |   - 'Tutorial': 'add-search-to-a-map.md'
21 |   - 'Release notes': 'release-notes.md'
22 | 
23 | mz:redirects:
24 |   'get-started': '.'
25 |   'transition-from-beta': '.'
26 |   'api-keys-rate-limits': '.'
27 | 
28 | extra:
29 |   site_subtitle: 'Find places and addresses with this geographic search service built on open tools and open data.'
30 |   project_repo_url: https://github.com/pelias/
31 |   docs_base_url: https://github.com/pelias/pelias-doc/blob/master
32 | 


--------------------------------------------------------------------------------
/config/tangram.yml:
--------------------------------------------------------------------------------
 1 | site_name: Tangram
 2 | docs_dir: src-tangram
 3 | site_dir: dist-tangram
 4 | 
 5 | # Because Tangram does not organize documentation in folders, we're going to have
 6 | # to enforce the Table of Contents structure manually in the configuration below.
 7 | # This means pages should be added or subtracted manually here if the files change.
 8 | pages:
 9 |   - Home: index.md
10 |   - Concept overviews:
11 |     - 'Tangram': 'Tangram-Overview.md'
12 |     - 'The scene file': 'Scene-file.md'
13 |     - 'Data filters': 'Filters-Overview.md'
14 |     - 'Styles': 'Styles-Overview.md'
15 |     - 'Shaders': 'Shaders-Overview.md'
16 |     - 'Raster sources': 'Raster-Overview.md'
17 |     - 'Lights': 'Lights-Overview.md'
18 |     - 'Cameras': 'Cameras-Overview.md'
19 |     - 'Materials': 'Materials-Overview.md'
20 |     - 'YAML': 'yaml.md'
21 |   - Syntax reference:
22 |     - 'cameras': 'cameras.md'
23 |     - 'draw': 'draw.md'
24 |     - 'global': 'global.md'
25 |     - 'fonts': 'fonts.md'
26 |     - 'import': 'import.md'
27 |     - 'layers': 'layers.md'
28 |     - 'lights': 'lights.md'
29 |     - 'materials': 'materials.md'
30 |     - 'scene': 'scene.md'
31 |     - 'shaders': 'shaders.md'
32 |     - 'sources': 'sources.md'
33 |     - 'styles': 'styles.md'
34 |     - 'textures': 'textures.md'
35 |   - Get started:
36 |     - Setup guides:
37 |       - 'Setup overview': 'Tangram-Setup.md'
38 |       - 'JavaScript setup': 'walkthrough.md'
39 |       - 'JavaScript bundling': 'bundling.md'
40 |       - 'Android setup': 'android-walkthrough.md'
41 |       - 'iOS setup': 'iOS-walkthrough.md'
42 |     - Tutorials:
43 |       - 'Custom styles': 'tutorials/custom-styles.md'
44 |       - 'Editing basemaps': 'tutorials/editing-basemaps.md'
45 |     - 'Demos': 'demos.md'
46 |   - JavaScript API: 'Javascript-API.md'
47 |   - Android API: 'Android-API.md'
48 |   - iOS API: 'iOS-API.md'
49 | 
50 | # Determines if a broken link to a page within the documentation is considered
51 | # a warning or an error (link to a page not listed in the pages setting). Set
52 | # to true to halt processing when a broken link is found, false prints a warning.
53 | strict: false
54 | 
55 | # Extra variables for templates
56 | extra:
57 |   site_subtitle: Render 2D and 3D maps with fine control over almost every aspect of the map-making process.
58 |   project_repo_url: https://github.com/tangrams/tangram
59 |   docs_base_url: https://github.com/tangrams/tangram-docs/tree/gh-pages/pages
60 | 


--------------------------------------------------------------------------------
/config/terrain-tiles.yml:
--------------------------------------------------------------------------------
 1 | site_name: Terrain Tile Service
 2 | docs_dir: src-terrain-tiles
 3 | site_dir: dist-terrain-tiles
 4 | 
 5 | pages:
 6 |   - Home: index.md
 7 |   - 'Formats': 'formats.md'
 8 |   - 'Get started': 'use-service.md'
 9 |   - 'Build a map': 'build-a-map.md'
10 |   - 'Data sources': 'data-sources.md'
11 |   - 'HTTP status codes': 'http-status-codes.md'
12 | 
13 | mz:redirects:
14 |   'attribution': '.'
15 |   'api-keys-and-rate-limits': '.'
16 | 
17 | # Extra variables for templates
18 | extra:
19 |   site_subtitle: 'Add open elevation data to your applications with the raster tile map service.'
20 |   project_repo_url: https://github.com/tilezen/joerd
21 |   docs_base_url: https://github.com/tilezen/joerd/tree/master/docs
22 |   exclude_home_contents_in_toc: false
23 | 


--------------------------------------------------------------------------------
/config/vector-tiles.yml:
--------------------------------------------------------------------------------
 1 | site_name: Vector Tile Service
 2 | docs_dir: src-vector-tiles
 3 | site_dir: dist-vector-tiles
 4 | 
 5 | pages:
 6 |   - Home: index.md
 7 |   - 'Layers': 'layers.md'
 8 |   - 'Get started': 'use-service.md'
 9 |   - 'Make a map': 'display-tiles.md'
10 |   - 'Data sources': 'data-sources.md'
11 |   - 'HTTP Status Codes': 'http-status-codes.md'
12 |   - 'Migrate to version 1.0': 'migrate-to-vector-tiles-v1.md'
13 |   
14 | mz:redirects:
15 |   'attribution': '.'
16 |   'api-keys-and-rate-limits': '.'
17 | 
18 | # Extra variables for templates
19 | extra:
20 |   site_subtitle: 'Add open geospatial data to your applications with the vector tile map service.'
21 |   project_repo_url: https://github.com/tilezen/vector-datasource
22 |   docs_base_url: https://github.com/tilezen/vector-datasource/tree/master/docs
23 |   exclude_home_contents_in_toc: false
24 | 


--------------------------------------------------------------------------------
/deploy.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh -ex
2 | make
3 | ./run-checklist.py
4 | aws s3 sync dist s3://static-dev.mapzen.com/documentation/
5 | aws s3 sync dist $AWS_DESTINATION
6 | 


--------------------------------------------------------------------------------
/docs/guides/github-tutorial.md:
--------------------------------------------------------------------------------
  1 | # Tutorial: Learn GitHub by building a website
  2 | 
  3 | GitHub is a website that enables people to collaborate on projects, and many organizations use it for managing both software code and documentation. You will get started with GitHub by applying its tools to creating a website.
  4 | 
  5 | In this tutorial, you will:
  6 | 
  7 | - Get an introduction to the Git version control system, terminology, and the GitHub workflow.
  8 | - Create a simple website with the free hosting service from GitHub, called GitHub Pages.
  9 | - Learn how you can take your new skills and to support other open-source projects.
 10 | 
 11 | To complete the tutorial, you need a [GitHub account](https://help.github.com/articles/signing-up-for-a-new-github-account/), a browser, and an internet connection.
 12 | 
 13 | ## Get to know the terms
 14 | 
 15 | While this tutorial assumes some knowledge of basic computing, you may not be familiar with the concepts for Git and GitHub. Here are some of the terms you will encounter in this tutorial.
 16 | 
 17 | _[Git](https://en.wikipedia.org/wiki/Git)_ is a version-control software library that tracks revisions and manages changes to files. It was developed by [Linus Torvalds](https://en.wikipedia.org/wiki/Linus_Torvalds), who created the Linux kernel that is used in Linux, Android, and other operating systems.
 18 | 
 19 | _[GitHub](https://github.com)_ is a website where you use Git tools to collaborate with other people working on a project. GitHub has the file history functionality from Git, and adds some of its own features.
 20 | 
 21 | You can think of a Git _repository_ as the folder for your project that contains all the component files, such as code, documentation, and examples. You can store your repositories on GitHub, where they can be publicly visible (open source) or be private and only accessible to certain users.
 22 | 
 23 | When you start working on a project, you need to make your own _branch_ of a repository, which is a parallel version that contains your changes. As you make modifications, like adding or deleting lines of code or files, you save, or _commit_, your changes.
 24 | 
 25 | To propose integrating your commits into the production version of the project, known as the _master branch_, you open a _pull request_. A pull request is the way you start a discussion with others about your changes because you want them pulled into the master branch. Other _collaborators_ on the project can review and approve your work. After your pull request is _merged_, your changes are added to the master branch.
 26 | 
 27 | You can review the [GitHub Glossary](https://help.github.com/articles/github-glossary/) to learn more about common terms.
 28 | 
 29 | ## Copy the files to your account
 30 | 
 31 | To get started, you need to make a copy of the repository containing the tutorial data files. You do not have write permissions for the source version, but making a copy into your own GitHub account allows you to edit them. This is known as creating a _fork_, or _forking a repository_.
 32 | 
 33 | 1. Open a browser to https://github.com and sign in with your account.
 34 | 2. Navigate to https://github.com/mapzen/write-the-docs-tutorial, which contains some files to get you started.
 35 | 3. Click the `Fork` button in the top right corner of the page.
 36 | 
 37 |     ![Fork a repository button](images/fork-repo-button.png)
 38 | 
 39 | 4. You may be prompted where to place the forked repository. Choose the option that will put the copy into your personal account, rather than forking it into any _organization_ to which you belong. An organization is a group of users on GitHub.
 40 | 
 41 | You now have a copy of the repository that you can edit. If you look at the repository name, it shows the name of the source repository from which it was forked.
 42 | 
 43 | _Tip: You can download a copy of a repository to your local machine. Doing this allows you to work offline, use more sophisticated editing tools, such as a text editor or integrated development environment, and work with git through a [command-line interface](https://git-scm.com/book/en/v2/Getting-Started-The-Command-Line). These workflows are beyond the scope of the tutorial._
 44 | 
 45 | ## Explore the files
 46 | 
 47 | The files provided for the tutorial include information about the repository's license, some markdown documents, and a `docs` folder. You are going to create a web page from the contents of the `docs` folder.
 48 | 
 49 | 1. Look at the files in your forked repository.
 50 | 2. Click the `docs` folder to display its contents. It contains `_config.yml` with configuration information to set up the website.
 51 | 
 52 | These files are used with [Jekyll](https://jekyllrb.com/), a software library written in Ruby that converts text files, such as the markdown files you see here, into a static website or blog. Jekyll is very flexible, and you can [review the documentation](https://jekyllrb.com/docs/home/) to learn more about how to customize it for your site. [GitHub Pages](https://pages.github.com/), which the free website hosting service you are using in this tutorial, is powered by Jekyll.
 53 | 
 54 | _Tip: The site template and layouts you are using are from a theme called Minima, which is the built-in style for Jekyll. You can see an example and view the open-source code in the [Minima repository](https://github.com/jekyll/minima)._
 55 | 
 56 | ## Create a homepage
 57 | 
 58 | Your fork has the basic configuration to get a website built with Jekyll, but does not have any content in it. You need to create an index file to serve as the homepage of your website.
 59 | 
 60 | Markdown is a lightweight markup language that uses plain text with symbols, like asterisks and underscores, to style the appearance. You use markdown formatting throughout GitHub, and many files are in `.md` format. Two syntax references are from [John Gruber](https://daringfireball.net/projects/markdown/syntax), who created markdown, and [GitHub](https://guides.github.com/features/mastering-markdown/). Jekyll converts markdown files into HTML for use on a website.
 61 | 
 62 | 1. Be sure you are in the `docs` folder (the path should be `write-the-docs-tutorial/docs`) and click `Create new file`.
 63 | 
 64 |     ![Create new file button](images/create-new-file-button.png)
 65 | 
 66 | 2. In the `Name your file` box, type `index.md`. It is very important that you include the `.md` file extension in the name; otherwise, your website will not be generated.
 67 | 3. On the `Edit new file` tab, add all the following text.
 68 |   ```
 69 |   ---
 70 |   layout: default
 71 |   title: Home
 72 |   ---
 73 | 
 74 |   Hello, world!
 75 |   ```
 76 | 
 77 | The text between the two lines of hyphens (`---`) is metadata, known as front matter, that Jekyll processes to display the page. You can use variables and other options in the front matter to customize your site. GitHub Pages can make any markdown file into a website, so tries to assign the page metadata automatically if it is not present.
 78 | 
 79 | You are setting the page layout and giving the page a title. The content that comes after this is what is displayed on your page (Hello, world!).
 80 | 
 81 |  _Tip: If you ever need to create a new subfolder in your directory structure when you are creating a file, you can type the folder name and a `/` after it, and then the filename._
 82 | 
 83 | ## Open a pull request for your edits
 84 | 
 85 | Git is referred to as a _distributed version control system_. While you are working on your changes, other people can be simultaneously editing in their own copies, or _branches_, of the repository. With this decentralized model, multiple people can work on different parts of a project without interfering with each other.
 86 | 
 87 | In GitHub, a _[pull request](https://help.github.com/articles/about-pull-requests/)_ is the way you propose changes to a project. It is called a pull request because you are asking to have your modifications be pulled into the main or production version of the repository, known as the _master branch_.
 88 | 
 89 | It is always good practice to create a branch and a pull request for your changes, rather than saving (known as _committing_) them directly to the master branch. With a pull request, other people can review and verify your changes, making it less likely that you will introduce a problem that could destabilize the project. In addition, if you commit straight to the master, others may not know about your modifications until they attempt to merge their own changes and unexpectedly find conflicting edits. It is also easier to revert a change if it originated from a pull request.
 90 | 
 91 | Review the [GitHub Flow](https://guides.github.com/introduction/flow/) documentation for more information and diagrams of the branching and merging process.
 92 | 
 93 | _Tip: You can click Graphs > Network or the number next to the Fork button, to view a timeline schematic of the branching and merging that has occurred in a repository._
 94 | 
 95 | 1. Scroll to the `Commit new file` section of the page.
 96 | 2. In the first box, type `Create website index file`.
 97 | 
 98 |     This is a commit message, where you can explain your work. Providing a descriptive and meaningful message is important so you and others are able to know what is happening in this group of edits and be able to refer back to them in the future. If you do not add any text, GitHub includes a default message.
 99 | 
100 | 3. Click `Create a new branch for this commit and start a pull request.`
101 | 
102 |     On this page, GitHub is combining three actions into one: creating a branch for your changes, committing your them to the branch, and starting a pull request.
103 | 
104 |     _Tip: When you are making more complex edits, you may want to create a branch from the Branch menu and reuse the branch for multiple commits._
105 | 
106 | 4. GitHub automatically suggests a branch name based on your username. You can use it or type your own, such as `new-index-file`. The branch name should be descriptive, and some organizations may have naming standards.
107 | 
108 |     ![Commit new file](images/index-file-commit-small.png)
109 | 
110 | 5. Click `Propose new file`.
111 | 
112 |     The page refreshes and you are on a page where you can open a pull request to propose your changes be merged into the master branch. The subject of the pull request is the commit message you typed before.
113 | 
114 | 6. Add some additional information about your the changes you are proposing in the comment box, such as `This adds an index file to create the homepage for the website.`
115 | 
116 |     ![Open a pull request page](images/open-pull-request-small.png)
117 | 
118 | 7. Scroll the page and review the other information displayed on the pull request. For example, you can see the list of commits (there is only one) and the changes you made.
119 | 8. Click `Create pull request`.
120 | 
121 | _Tip: Because you are working in a repository in your own account, you technically have the ability to commit directly into the master branch. However, you should still follow the recommendation and create a pull request for your own projects._
122 | 
123 | ## Merge changes into the master branch
124 | 
125 | You have opened a pull request in your repository, and now need to approve the changes and merge them into the master branch.
126 | 
127 | Most of the time, other collaborators review and approve your pull request before it is merged. GitHub has [additional reviewing functionality](https://help.github.com/articles/about-pull-request-reviews/), including adding comments on individual lines of code and requiring changes to be made before the pull request can be merged. Administrators can also limit who can merge into the master branch.
128 | 
129 | In this case, you are the only contributor to this repository and need to review and merge your own changes.
130 | 
131 | 1. Review the information on the pull request page.
132 | 
133 |     ![Pull request page](images/pull-request-page-small.png)
134 | 
135 | 2. Below the merge section, type a comment and click `Comment`. Comments are used to discuss the changes. You can use emoji and markdown in your comments.
136 | 
137 |     ![Add a comment to a pull request](images/pull-request-add-comment-small.png)
138 | 
139 | 3. Click `Merge pull request`.
140 | 
141 |     Your changes are compatible and do not conflict with the master branch, so can be merged automatically. However, sometimes, when multiple people are editing the same part of a file, GitHub cannot determine which change is correct. If this happens, you may need to use [command-line options](https://help.github.com/articles/resolving-a-merge-conflict-from-the-command-line/) to review and reconcile merge conflicts.
142 | 
143 | 4. Click `Confirm merge`.
144 | 5. Click `Delete branch` to remove the temporary branch.
145 | 
146 |     ![Delete the old branch](images/pull-request-delete-branch.png)
147 | 
148 | You have now merged your changes into the master branch, and the pull request status shows as `Merged`. Congratulations if this is your first pull request!
149 | 
150 | ## Enable GitHub Pages on the repository
151 | 
152 | [GitHub Pages](https://help.github.com/articles/what-is-github-pages/) is a free website-hosting service for repositories stored on GitHub. You can use GitHub pages for a variety of projects, including your personal blog or a corporate website.
153 | 
154 | To use GitHub Pages, you need to specify the source of the files used to build the website. In the simplest workflow, you can publish the site from one of these two sources:
155 | 
156 | - the entire master branch, which is useful if the repository only contains files used for the website
157 | - the contents of a folder named `docs` in the master branch
158 | 
159 | The option to use the `docs` folder, which is what you will be doing, allows you to store documentation in the same repository alongside the code it describes. You are using the default visual style, but GitHub Pages has other options for building your own themes or custom sites.
160 | 
161 | 1. Click `Settings` near the top of the page.
162 | 
163 |     ![Repository settings button](images/repository-settings-button.png)
164 | 
165 | 2. On the main `Options` tab, scroll to the `GitHub Pages` section.
166 | 3. Under `Source`, click `master branch /docs folder`.
167 | 
168 |     ![GitHub Pages source using the /docs folder](images/github-pages-source.png)
169 | 
170 | 4. Click `Save`.
171 | 5. After the page refreshes, scroll back to the `GitHub Pages` section, if necessary, and notice that there is a banner indicating your site is ready to be published.
172 | 7. Refresh the page again. You should now see a note that indicates your site has been published and its URL.
173 | 8. Click the URL to view your website (you may want to open it in a new browser tab). If you get a 404 error, keep trying because it may take a few minutes to generate the site.
174 | 
175 | After the page loads, your should have a formatted website with one page, a header and footer (this comes from the settings in `_config.yml`), and the "Hello, world!" text you entered in the index file.
176 | 
177 | _Tip: By default, the URL takes the form of `<username>.github.io/<repository>` name. If you have used GitHub Pages before and set up a custom domain name for the base URL, this is also reflected in this site._
178 | 
179 | ## Add content to your page
180 | 
181 | You next can replace the "Hello, world!" text with real content. You can copy text from a sample markdown file in this repository and paste it into your index file.
182 | 
183 | 1. Go back to your GitHub repository.
184 | 2. In the root level of the repository, find and open the file named `sample-text-for-website.md`.
185 | 3. Click the `Raw` button to view the plain text, including the markdown formatting.
186 | 
187 |     ![View the raw file content](images/raw-button.png)
188 | 
189 | 4. Select all the text and copy it.
190 | 5. Navigate to the `index.md` file in the `docs` folder.
191 | 6. Click `Edit this file`.
192 | 
193 |     ![Start editing the file](images/edit-this-text-button.png)
194 | 
195 | 7. Delete the "Hello, world!" text, making sure to leave in place the front matter section above it. (If you do accidentally delete it, GitHub Pages tries to assign the page metadata automatically.)
196 | 8. Paste the text you copied after the second `---` line.
197 | 9. Following the same workflow you did before, commit your changes into a new branch and start a pull request.
198 | 10. Open the pull request, merge your changes into the master branch, and delete the temporary branch.
199 | 11. Refresh your website to see your changes.
200 | 
201 | _Tip: If you closed the browser tab with your GitHub Pages website, you can go back to your repository settings and find the link to the site there._
202 | 
203 | Your basic website is complete.
204 | 
205 | ## Next steps
206 | 
207 | ### Enhance your website
208 | 
209 | On your own, here are some of the tasks you can do to continue enhancing your site.
210 | 
211 | 1. Add more pages to your website.
212 | 
213 |     - Files you add in the `docs` folder will be at a URL that matches the file name. For example, `about.md` will display at `/about`.
214 |     - Add a blog to your site by creating a `_posts` folder in the `docs` folder. By default, files should be named `YYYY-MM-DD-my-new-post.md`, where YYYY-MM-DD is the year, month, and day it is posted and the file name. This shows up on your site at a URL similar to `YYYY/MM/DD/my-new-post`.
215 | 
216 | 2. Customize the site configuration in `_config.yml`.
217 | 3. Experiment with other themes, including the automatic site generation tools under the repository settings.
218 | 4. Make a local copy of the repository and learn how to use the command-line interface to modify the files.
219 | 5. Improve the original repository by [making a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) from enhancements in your fork.
220 | 
221 | _Tip: If you want to remove your GitHub Pages site or delete the repository, open the repository settings._
222 | 
223 | ### Contribute to other open-source projects
224 | 
225 | Now that you are familiar with using GitHub, you can use this same workflow to collaborate on the many open-source projects that are hosted there.
226 | 
227 | Documentation can be an easy way to get started contributing to a project. For example, if you find a typographic error on a documentation page, you can fork the repository and suggest a fix. In fact, if you click the `Edit this file` button on the file you want to change, GitHub automatically creates a fork for you and opens a pull request on the original project.
228 | 
229 | If you find a bug or have suggestions for a project but are unable or do not want to fix them yourself, report an _issue_ in the repository to notify the contributors. You can also use the issues list to find known problems that you may be able to assist with, which are sometimes tagged with `help wanted`.
230 | 
231 | GitHub repositories often contain [guidelines for contributing](https://help.github.com/articles/setting-guidelines-for-repository-contributors/) to the project, including how to format your pull request and the code of conduct. Be sure to review and follow these instructions to help maintain a positive open-source community.
232 | 


--------------------------------------------------------------------------------
/docs/guides/images/create-new-file-button.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mapzen/documentation/d760f647beed2ac98f0f91cacd6dbbc58f3b4772/docs/guides/images/create-new-file-button.png


--------------------------------------------------------------------------------
/docs/guides/images/edit-this-text-button.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mapzen/documentation/d760f647beed2ac98f0f91cacd6dbbc58f3b4772/docs/guides/images/edit-this-text-button.png


--------------------------------------------------------------------------------
/docs/guides/images/fork-repo-button.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mapzen/documentation/d760f647beed2ac98f0f91cacd6dbbc58f3b4772/docs/guides/images/fork-repo-button.png


--------------------------------------------------------------------------------
/docs/guides/images/github-pages-source.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mapzen/documentation/d760f647beed2ac98f0f91cacd6dbbc58f3b4772/docs/guides/images/github-pages-source.png


--------------------------------------------------------------------------------
/docs/guides/images/index-file-commit-small.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mapzen/documentation/d760f647beed2ac98f0f91cacd6dbbc58f3b4772/docs/guides/images/index-file-commit-small.png


--------------------------------------------------------------------------------
/docs/guides/images/index-file-commit.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mapzen/documentation/d760f647beed2ac98f0f91cacd6dbbc58f3b4772/docs/guides/images/index-file-commit.png


--------------------------------------------------------------------------------
/docs/guides/images/open-pull-request-small.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mapzen/documentation/d760f647beed2ac98f0f91cacd6dbbc58f3b4772/docs/guides/images/open-pull-request-small.png


--------------------------------------------------------------------------------
/docs/guides/images/open-pull-request.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mapzen/documentation/d760f647beed2ac98f0f91cacd6dbbc58f3b4772/docs/guides/images/open-pull-request.png


--------------------------------------------------------------------------------
/docs/guides/images/pull-request-add-comment-small.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mapzen/documentation/d760f647beed2ac98f0f91cacd6dbbc58f3b4772/docs/guides/images/pull-request-add-comment-small.png


--------------------------------------------------------------------------------
/docs/guides/images/pull-request-add-comment.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mapzen/documentation/d760f647beed2ac98f0f91cacd6dbbc58f3b4772/docs/guides/images/pull-request-add-comment.png


--------------------------------------------------------------------------------
/docs/guides/images/pull-request-delete-branch.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mapzen/documentation/d760f647beed2ac98f0f91cacd6dbbc58f3b4772/docs/guides/images/pull-request-delete-branch.png


--------------------------------------------------------------------------------
/docs/guides/images/pull-request-page-small.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mapzen/documentation/d760f647beed2ac98f0f91cacd6dbbc58f3b4772/docs/guides/images/pull-request-page-small.png


--------------------------------------------------------------------------------
/docs/guides/images/pull-request-page.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mapzen/documentation/d760f647beed2ac98f0f91cacd6dbbc58f3b4772/docs/guides/images/pull-request-page.png


--------------------------------------------------------------------------------
/docs/guides/images/raw-button.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mapzen/documentation/d760f647beed2ac98f0f91cacd6dbbc58f3b4772/docs/guides/images/raw-button.png


--------------------------------------------------------------------------------
/docs/guides/images/repository-settings-button.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mapzen/documentation/d760f647beed2ac98f0f91cacd6dbbc58f3b4772/docs/guides/images/repository-settings-button.png


--------------------------------------------------------------------------------
/docs/guides/index.md:
--------------------------------------------------------------------------------
1 | Follow these developer guides to learn general tips for setting up your software development environment. This includes how to install a text editor, run a local web server for testing, and set up a remote web server where you can host your code.
2 | 


--------------------------------------------------------------------------------
/docs/guides/install-text-editor.md:
--------------------------------------------------------------------------------
 1 | # Install a text editor
 2 | 
 3 | A text editor is an application that will allow you to edit plain text files.  
 4 | 
 5 | While you can use the apps installed with your operating system, such as Notepad for Windows or TextEdit for Mac, they do not provide the helpful indentations, code coloring and autocomplete, or text alignment options found in the other editors. To use TextEdit, you must go to the Format menu and click Make Plain Text to use the plain-text version of the file. 
 6 | 
 7 | Do not use an app that applies rich formatting, such as Microsoft Word or Wordpad. These rich text editors include formatting that will confuse your code.
 8 | 
 9 | Here are a few recommended editors:
10 | 
11 | * [Atom](https://atom.io/) (Mac, Windows, Linux) 
12 | * [Sublime Text](https://www.sublimetext.com/) (Mac, Windows, Linux; free trial) 
13 | * [Notepad ++](https://notepad-plus-plus.org/download/) (Windows only) 
14 | * [TextWrangler](http://www.barebones.com/products/TextWrangler/) (Mac only) 
15 | 


--------------------------------------------------------------------------------
/docs/guides/server-environment.md:
--------------------------------------------------------------------------------
 1 | # Set up your server environment
 2 | 
 3 | As you begin writing code, there will be a time when you need to set up a local server development environment on your computer. This will involve setting up a local server to test your code and a remote server to share that code with others.
 4 | 
 5 | ## Start a local web server
 6 | 
 7 | Sometimes, you need to set up a web server on your own machine, especially when you need to run JavaScript or other code properly. To start the server, you will need to enter a few command line instructions using the terminal window.
 8 | 
 9 | 1. Open a terminal window to the folder containing the files you need to serve. You can type `cd` and the pathname to navigate to the proper directory path.
10 | 2. At the prompt, type `python -m SimpleHTTPServer` to start a web server using Python. You should receive a message similar to this in the terminal: `Serving HTTP on 0.0.0.0 port 8000 ...`
11 | 3. Open your browser to `http://localhost:8000`. (“Localhost” is a shortcut hostname that a computer can use to refer to itself, and is not viewable by anyone else.) If it was successful, you should see the same demo map as you viewed earlier. If you are having problems, you can instead try the command `python -m http.server 8000` (for use with Python 3).
12 | 4. As soon as you close the terminal window, this server will close. Leave your terminal window open as you work.
13 | 
14 | _Tip:  By default, terminal windows open into your home directory, so you will need to drill into the folder structure to get to the simple-demo folder. Alternatively, add a shortcut to your context menu so you can right-click a folder in Finder and start the terminal window in that location. To enable this, open System Preferences, click Keyboard, and click Shortcuts. In the list, click Services and check New Terminal at Folder._
15 | 
16 | ## Use a remote web server
17 | 
18 | There are many options for getting your map or other project onto the web where it can be shared with others. Use whichever fits your situation best.
19 | 
20 | **Option 1**: [bl.ocks.org](https://bl.ocks.org).
21 | 
22 | This site is a view for code hosted as [GitHub Gist](https://gist.github.com/).
23 | 
24 | 1. Go to [https://gist.github.com](https://gist.github.com).  
25 | 2. Add your HTML page. Call it `index.html` and copy and paste in your HTML code.
26 | 3. Click `Add file` to include additional files.
27 | 4. When you are finished, click `Create public gist`.  The page will reload with your saved file, known as a gist.
28 | 5. In your browser's navigation bar, replace `gist.github.com` with `bl.ocks.org`. You are changing  `https://gist.github.com/<username>/<id>` to `https://bl.ocks.org/<username>/<id>`.
29 | 6. View your page at `https://bl.ocks.org/<username>/<id>`
30 | 
31 | _Tip: You can also try [blockbuilder.org](http://blockbuilder.org/), which automates the gist to bl.ocks workflow for you._
32 | 
33 | **Option 2**: [Dropbox](https://www.dropbox.com/)
34 | 
35 | You can use Dropbox's web servers to host your files. That public link you copied can be viewed by anyone who has the link.
36 | 
37 | 1. Save your project files to your public directory of Dropbox.
38 | 2. Right-click (or _&#8984; + click_) on the main HTML file, such as `index.html`, and click `Copy Public Link`.
39 | 3. Paste that link into your browser.
40 | 
41 | **Option 3**: GitHub Pages
42 | 
43 | [GitHub Pages](https://help.github.com/articles/what-is-github-pages/) is a free hosting service for repositories stored on GitHub. You can use GitHub pages for a variety of projects, including your personal blog or a corporate website.
44 | 
45 | You need to specify the source of the files used to build the website. In the simplest workflow, you can publish the site from one of these two sources:
46 | 
47 | - the entire master branch, which is useful if the repository only contains files used for the website
48 | - the contents of a folder named `docs` in the master branch, if you are hosting documentation
49 | 
50 | Add your files to the repository, and enable GitHub Pages from the repository settings page.
51 | 
52 | You can also store your files in a `gh-pages` branch, which is a special branch that automatically creates GitHub Pages websites.
53 | 


--------------------------------------------------------------------------------
/docs/overview/account-settings.md:
--------------------------------------------------------------------------------
  1 | # Update your Mapzen account settings
  2 | 
  3 | When you signed in on Mapzen’s website, you can view and modify your account settings. These include changing your email address and password, and updating your credit card and billing information.
  4 | 
  5 | ## Sign up for a Mapzen account
  6 | 
  7 | 1. Go to https://mapzen.com.
  8 | 2. Click `Sign Up`.
  9 | 3. Choose your authentication method. Create your account by entering your e-mail address and password, or if you have a [GitHub](https://github.com) account, you can use it for authentication. GitHub is a website that enables people to collaborate on a project.
 10 | 
 11 | When you create an account, you need to agree to the Mapzen [Terms of Service](https://mapzen.com/terms/).
 12 | 
 13 | In the future when you sign in, use either your email address and password or GitHub account, depending on how you registered originally. If you forgot your password, you can also attempt to reset it.
 14 | 
 15 | ## Change your email address or password
 16 | 
 17 | 1. Sign in to your Mapzen account.
 18 | 2. In the top corner of the page, click `Account` and click `Settings`.
 19 | 3. If you are using an email address to sign in, you can update your email address and password. You can also update the name on your account.
 20 | 4. With GitHub authentication, you can change your email address where you receive communications from Mapzen. Note that this is the address that was part of your GitHub profile when you originally authenticated your Mapzen account.
 21 | 
 22 | ## Add your payment method
 23 | 
 24 | To use any of Mapzen’s services above the free limits, you need to add a payment method to your account.
 25 | 
 26 | If you do not have a valid credit card on file and you reach the free limits, your access to that Mapzen service will cease for the remainder of the month. You can continue to use other services up to their individual free limits.
 27 | 
 28 | At the end of each month, Mapzen calculates your usage and bill, and your charges are paid automatically by the credit card on file.
 29 | 
 30 | 1. Sign in to your Mapzen account.
 31 | 2. In the top corner of the page, click `Account` and click `Settings`.
 32 | 3. In the `Billing` section, `Add Payment Method`.
 33 | 4. Enter your credit card information.
 34 | 
 35 | If your account has any pending usage charges in a month, you can update it to a different credit card, but are unable to delete your credit card altogether until the balance has cleared.
 36 | 
 37 | To have details such as your mailing address or tax identification number appear on your monthly invoice, click `Update` under `Billing info`. All fields on the form are optional, so you can choose which ones you want to display on the invoice.
 38 | 
 39 | ## Set monthly spending limits
 40 | 
 41 | You can set limits on your spending each month. This gives you the comfort of knowing that your bill will not exceed the amount you specify. You will only be charged for what you use, which may be less than the limit you set for the month.
 42 | 
 43 | To set a spending limit, you first need to add a payment method to your account. By default, there is no spending limit on your account, which means your usage (and potential bill) is unrestricted.
 44 | 
 45 | Limits can be changed at any time, but cannot be set to an amount lower than the already accrued charges for that month. After you change your limit, the monthly spending limit stays the same month after month into the future. You will be notified by email as you approach your spending limit.
 46 | 
 47 | The spending limit applies across all services. If you reach your spending limit by using only Mapzen Search, for example, you will not be able to use Mapzen Search or any other services beyond the free limits for the remainder of the month. Your account will not accumulate any charges for overages, but no results will be returned for your API requests. This means that your maps may no longer function.
 48 | 
 49 | Rate limits are reset on the first day of every month at 00:00 UTC (Coordinated Universal Time).
 50 | 
 51 | See https://mapzen.com/pricing for more information on current pricing and the limits available with the free plan.
 52 | 
 53 | 1. Sign in to your Mapzen account.
 54 | 2. In the top corner of the page, click `Account` and click `Settings`.
 55 | 3. Make sure you have a payment method on your account. You will not see additional billing information unless you have a credit card on file.
 56 | 4. In the `Billing` section, click `Update` under `Monthly spending limit`.
 57 | 5. Make sure your billing status is `Enabled`.
 58 | 6. Enter the maximum you want to spend across all Mapzen services.
 59 | 
 60 | As you approach your spending limit, your choices are to increase your spending limits, adjust your usage, or accept that your access to higher rate limits will end.
 61 | 
 62 | ## Set your billing status
 63 | 
 64 | When billing is enabled, you have access to Mapzen services at levels above the free limits and are agreeing to pay for your usage, up to your monthly spending limit, if one exists. By default, billing is enabled when you add a payment method to your account.
 65 | 
 66 | To stop billing, set your billing status to disabled in the `Billing` section of your account settings. This has the effect of setting your monthly spending limit to $0 because you are only able to use Mapzen services up to the free limits of each product. If you exhaust the free limits, your maps may no longer function.
 67 | 
 68 | Any charges that were pending before you disabled billing will still be charged to the credit card on file at the end of the current billing cycle. However, no further charges can accrue. The billing status remains as you set it until you change it in the future.
 69 | 
 70 | Anytime you want to start billing again, set your billing status to `Enabled`.
 71 | 
 72 | ## Enable premium support		
 73 | 
 74 | Premium support, which includes faster response times and a service-level agreement, is available for an additional [monthly fee](https://mapzen.com/pricing/#premium-support). You can add premium support even if you are within the free rate limits of Mapzen’s products.
 75 | 
 76 | When contacting Mapzen, users with premium support receive priority replies. Premium support benefits are available to anyone at your organization, not just an individual account.
 77 | 
 78 | A service-level agreement indicates the service's required uptime and instructions to take if these are not met. These are detailed in the Mapzen [Terms of Service](https://mapzen.com/terms/).
 79 | 
 80 | [Learn more about Mapzen support offerings](support)
 81 | 
 82 | You are billed for premium support at the beginning of each month. You can use it as soon as you enable it on your account, and the fee is prorated when joining in the middle of a billing cycle.
 83 | 
 84 | If you choose to disable your premium support access, you can continue to use your benefits through the end of the month and your credit card will not be charged in subsequent months. No refunds are issued for the remainder of the billing period.
 85 | 
 86 | _Note: Premium support is for assistance with Mapzen's hosted web services and does not include help for on-premises installations of Mapzen's open-source projects. If you need help running your own instance, there are [community-based options](support.md#github-and-community-chat)._
 87 | 
 88 | 1. Sign in to your Mapzen account.		
 89 | 2. In the top corner of the page, click `Account` and click `Settings`.		
 90 | 3. Under `Support`, click `Enable` and agree to the terms.		
 91 | 4. To end premium support, under `Support`, click `Update` and disable it on your account.
 92 | 
 93 | ## Delete your Mapzen account
 94 | 
 95 | If you no longer want to have a Mapzen account, you can delete it permanently. When you do this, your API keys stop working almost immediately, which means any maps using them no longer function. You will lose access to your API keys, dashboard, and past usage data, and you will not be able to sign in again.
 96 | 
 97 | You can only delete your account if you have no outstanding charges.
 98 | 
 99 | _Tip: If you only need to update your name, email address, or billing information, you do not need to delete your account. You can change these in your account settings._
100 | 
101 | 1. Sign in to your Mapzen account.
102 | 2. In the top corner of the page, click `Account` and click `Settings`.
103 | 3. Click `Delete your account`. If you do not see this section, your account has a balance due that must be paid before you can delete it.
104 | 4. Review what happens when you delete your account, and confirm that you want take this action.
105 | 
106 | If you are using GitHub authentication on your Mapzen account, optionally, sign into your GitHub account and revoke [Mapzen Platform](https://help.github.com/articles/reviewing-your-authorized-applications-oauth/) as an authorized application.
107 | 
108 | You may still continue to receive emails from Mapzen. If you want to unsubscribe, use the links in the newsletter email.
109 | 


--------------------------------------------------------------------------------
/docs/overview/api-keys.md:
--------------------------------------------------------------------------------
 1 | # Create and manage your Mapzen API keys
 2 | 
 3 | When signed in to your Mapzen account, you can access a dashboard that allows you to create, manage, and track the usage of your Mapzen API keys. An API key is a code that uniquely links API usage inside your application with your Mapzen account without needing a password.
 4 | 
 5 | Mapzen's web services have various API endpoints that allow you to access web resources through a URL. You will need to include your API key in the URL you construct to send requests to Mapzen's services. For example, add an `api_key` URL parameter to any request, such as `?api_key=your-mapzen-api-key`. An API key works for any Mapzen service.
 6 | 
 7 | You must include an API key when using Mapzen's services; requests sent without an API key return errors.
 8 | 
 9 | ## Create an API key
10 | 
11 | 1. Go to https://mapzen.com.
12 | 2. In the top corner of the page, click `Account` and click `Dashboard`. This is where you can create, delete, and manage your API keys.
13 | 3. Create a new key.
14 | 4. Optionally, give the key a name so you can remember the purpose of the project.
15 | 5. When you are ready to use it, copy the key and paste it into your code. In your query, the API key parameter should take the form of `api_key=your-mapzen-api-key`, substituting your actual API key for `your-mapzen-api-key` part of the example.
16 | 
17 | _Note: The free rate limits are applied to your usage across your entire account. Creating multiple keys does not increase these limits._
18 | 
19 | ## Choose an API key strategy for your app
20 | 
21 | The simplest workflow is for your app to employ a centralized API key for all users. This could mean that you deploy your app with a single key with enough capacity to cover all of your users’ usage. A valid variation is to create and deploy multiple keys if you want to monitor usage and billing for a particular client or function within your app.
22 | 
23 | In this model, the API keys in your app are linked to your Mapzen account. This makes you responsible for the costs associated with all of the usage for the keys that are deployed in your app. You can set a spending limit on your account to avoid unexpected charges, although be aware that the app may not function after the spending limit is reached.
24 | 
25 | The alternative and more complex API key workflow is for your app to provide an option for users to enter an API key from their own Mapzen accounts. Doing this allows your users to have their own free rate limits, and makes them individually liable for their usage costs. If you implement this method, your app should clearly indicate that a valid Mapzen API key is required. Otherwise, your users will see errors if they fail to include an API key when using Mapzen's services.
26 | 
27 | ## Protect your API keys
28 | 
29 | If you want to keep your API key private, you can consider using a proxy system to hide the key from your users.
30 | 
31 | If you believe your API key has been compromised or used without your knowledge, contact [Mapzen](mailto:support@mapzen.com). You can also delete API keys or rotate them periodically in your app. There is not currently a default way to limit an API key for usage only on a particular web domain.
32 | 
33 | ### Example with mapzen.js
34 | 
35 | When using [mapzen.js](https://mapzen.com/documentation/mapzen-js/), in your YAML scene file that defines the Tangram map, add a `sources` parameter for the API key.
36 | 
37 | ```
38 | sources:
39 |     mapzen:
40 |         [...]
41 |         url_params:
42 |             api_key: global.sdk_mapzen_api_key
43 | ```
44 | 
45 | Then, in the JavaScript, use your actual key in place of `your-mapzen-api-key` in this code.
46 | 
47 | ```
48 | var map = L.Mapzen.map('map', {
49 |     tangramOptions: {
50 |         scene: {
51 |             [...]
52 |             global: {
53 |             sdk_mapzen_api_key: 'your-mapzen-api-key'
54 |             }
55 |         }
56 |     }
57 | }
58 | ```
59 | 
60 | ### Example with separate Tangram scene files
61 | 
62 | A method of obfuscating the API key is put it in a separate YAML file and use an `import:` statement to link to it from your main Tangram scene file.
63 | 
64 | 1. Import the file. See the [Tangram import documentation](https://mapzen.com/documentation/tangram/import/) for details.
65 | 
66 |     ```yaml
67 |     import: your-file.yaml #link to your YAML file
68 |     ```
69 | 
70 | 2. Reference the API key in the scene file.
71 | 
72 |     In your `sources` block, add `url_params`.
73 | 
74 |     ```yaml
75 |     sources:
76 |         mapzen:
77 |             [...]
78 |             url_params:
79 |                 api_key: global.sdk_mapzen_api_key
80 |     ```
81 | 
82 | 3. In your external file, define the key in a `global:` block.
83 | 
84 |     ```yaml
85 |     global:
86 |         sdk_mapzen_api_key: your-mapzen-api-key
87 |     ```
88 | 


--------------------------------------------------------------------------------
/docs/overview/billing.md:
--------------------------------------------------------------------------------
 1 | # View your current usage and bill
 2 | 
 3 | When you are signed in with your Mapzen account, you can view your current usage and charges due.
 4 | 
 5 | You can think of your Mapzen bill as similar to a home utility bill, where your charges are dependent on how much water or electricity, for example, you consumed in a month.
 6 | 
 7 | Because there are no paid tiers, you pay for each individual API request you make above the free rate limits. Although you may see pricing listed in units of 1,000, requests are not purchased in bundles. For example, $0.05 per 1,000 is intended to be a simpler way of representing that each request is $0.00005.
 8 | 
 9 | Billing is post-paid after the month ends, and there are no prepayment discounts available. There are no minimum fees for maintaining a Mapzen account, even if you have no usage for a while.
10 | 
11 | The billing currency is the United States Dollar (USD).
12 | 
13 | If you need to update your credit card information, you can do that from your [Mapzen account settings](account-settings.md#add-your-payment-method). If you have questions about your bill or are having problems paying it, please contact Mapzen at support@mapzen.com.
14 | 
15 | Rate limits are reset on the first day of every month at 00:00 UTC (Coordinated Universal Time).
16 | 
17 | ## View your usage
18 | 
19 | To check your usage, sign in to your developer account and review your dashboard.
20 | 
21 | 1. Sign in to your Mapzen account.
22 | 2. In the top corner of the page, click `Account` and click `Dashboard`. This page shows an account summary with your current requests and charges and lists your Mapzen API keys.
23 | 3. Click one of your API keys in the list and click `Usage`. The graphs show the number of requests on this key for each product.
24 | 4. To display your past billing details, in the `Billing` section, click `View billing history`. You see an overview of each billing period and status. Click the link to view a printable version of your invoice. You can add your name, address, or tax identification number to the invoice in your [Mapzen account settings](account-settings.md#add-your-payment-method).
25 | 
26 | ## Request a bill credit for service issues
27 | 
28 | _Note: This is only available to users who enable [premium support](account-settings.md#enable-premium-support), which includes a service-level agreement._
29 | 
30 | While Mapzen hopes you never experience an outage or downtime in services, you can request a credit in the event that issues occur. See the Mapzen [Terms of Service](https://mapzen.com/terms/) for more information about your rights and requirements, and keep in mind that those terms supersede any documentation content here.
31 | 
32 | 1. If you have [premium support](account-settings.md#enable-premium-support) enabled on your account and believe that Mapzen has not met the uptime percentage in the terms of service, record any information about the downtime you can, such as the service name and API, date and time, and estimated outage amount.
33 | 2. Within 15 days, send this to [Mapzen support](mailto:hello@mapzen.com) for review.
34 | 


--------------------------------------------------------------------------------
/docs/overview/index.md:
--------------------------------------------------------------------------------
 1 | # Get started developing with Mapzen
 2 | 
 3 | Mapzen’s products help you put a map anywhere, search and route the planet, and try a world of open data.
 4 | 
 5 | Follow these steps to get started developing on the Mapzen platform.
 6 | 
 7 | ## 1. Sign up for a Mapzen account
 8 | 
 9 | Your first step is to create a Mapzen developer account. After you sign in, you can modify your account settings, view your Mapzen service usage, and manage your API keys. An account and API keys are required to use Mapzen services, even within the free limits.
10 | 
11 | 1. Go to https://mapzen.com.
12 | 2. Click `Sign Up`.
13 | 3. Choose your authentication method.
14 | 
15 | [Learn more about creating a Mapzen account](account-settings.md#sign-up-for-a-mapzen-account)
16 | 
17 | ## 2. Get an API key
18 | 
19 | An API key is a code that uniquely links API usage inside your application with your Mapzen account. You must include a Mapzen API key with all your server requests.
20 | 
21 | When signed in to your Mapzen account, you can access a dashboard that allows you to create, manage, and track the usage of your Mapzen API keys.
22 | 
23 | One API key works for any Mapzen service.
24 | 
25 | [Learn how to create and manage your API keys](api-keys.md)
26 | 
27 | ## 3. Customize your billing settings
28 | 
29 | You can create an API key and use Mapzen's services up to the monthly rate limits for free. If you reach the limits on one Mapzen service, you can continue to use others up to their free limits. Rate limits reset at the beginning of every month.
30 | 
31 | If you need more than the free rate limits, [add a payment method to your account](account-settings.md#add-your-payment-method). Otherwise, if you exhaust the free limits, your maps may no longer function.
32 | 
33 | You can take control of your bill by [setting a monthly spending limit](account-settings.md#set-monthly-spending-limits). This gives you the comfort of knowing that your bill will not exceed the amount you specify. You can modify your spending limit at any time.
34 | 
35 | Your usage is calculated monthly and any balance due is automatically billed to the credit card in your account.
36 | 
37 | [Learn more about tracking your usage and billing](billing.md)
38 | 
39 | ## 4. Start building
40 | 
41 | If you are new to the Mapzen platform, you might try these tutorials.
42 | 
43 | - [Get started with mapzen.js](https://mapzen.com/documentation/mapzen-js/get-started/), the Mapzen JavaScript SDK
44 | - [Add Turn-by-Turn routing to a map](https://mapzen.com/documentation/mobility/turn-by-turn/add-routing-to-a-map/)
45 | - [Add the Mapzen Search geocoder to a map](https://mapzen.com/documentation/search/add-search-to-a-map/)
46 | - Get started with [Mapzen Android SDK](https://mapzen.com/documentation/android/getting-started/) and [Mapzen iOS SDK](https://mapzen.com/documentation/ios/getting-started/)
47 | 
48 | ### Learn about the limits and legal terms
49 | 
50 | #### Rate limits
51 | 
52 | Mapzen offers some level of free access to each service, subject to rate limits. The services have maximum numbers of requests you can make per month, and some have additional service limitations to minimize computationally intensive uses. To review the current limits for all Mapzen services, see [Rate limits](rate-limits.md).
53 | 
54 | #### Terms of use
55 | 
56 | Mapzen's products are available for any use, including commercial purposes. You need to follow the [attribution requirements](https://mapzen.com/rights/) for the data source, and also provide acknowledgement if you are using Mapzen's web services.
57 | 
58 | See the full [developer terms](https://mapzen.com/terms/) for more information.
59 | 


--------------------------------------------------------------------------------
/docs/overview/rate-limits.md:
--------------------------------------------------------------------------------
  1 | # Rate limits
  2 | 
  3 | Mapzen offers some level of free access to each service, subject to rate limits. The services have maximum numbers of requests you can make per month, and some have additional service limitations to minimize computationally intensive uses.
  4 | 
  5 | To use Mapzen’s services above the free limits, you need to [add a payment method to your account](account-settings.md#add-your-payment-method) and enable billing.
  6 | 
  7 | All the projects used to build the Mapzen-hosted services are open source. If you want to try Mapzen’s products, start with the hosted services to see if they fit your workflow needs. If you later decide that you need additional customizations, you can consider installing on your own servers the open-source code used to build Mapzen’s services.
  8 | 
  9 | You must include an API key when using Mapzen’s services; requests sent without an API key return errors.
 10 | 
 11 | ## Mapping products
 12 | 
 13 | ### mapzen.js (Mapzen JavaScript SDK)
 14 | 
 15 | To use [mapzen.js](https://mapzen.com/documentation/mapzen-js/), the Mapzen JavaScript SDK, you need an API key. You are subject to the rate limits for the Mapzen service you are integrating in your app.
 16 | 
 17 | ### Tangram
 18 | 
 19 | [Tangram](https://mapzen.com/documentation/tangram/), Mapzen's rendering software for web and mobile apps, does not require its own API key. However, if you are using Tangram to draw data from Mapzen's vector tiles service, you need an API key.
 20 | 
 21 | ### Mapzen Basemap Styles
 22 | 
 23 | Mapzen's [cartography](https://mapzen.com/documentation/cartography/) requires an API key to enable access to Mapzen vector and terrain tiles data sources.
 24 | 
 25 | ### Mapzen Vector Tiles
 26 | 
 27 | [Mapzen Vector Tiles](https://mapzen.com/documentation/vector-tiles/) provides global basemap coverage. The service has these limits:
 28 | 
 29 | - 50,000 free requests per month
 30 | 
 31 | When viewing a map, you commonly make about four requests at 512-pixel tile size, and about 15 requests at 256-pixel tile size.
 32 | 
 33 | The Mapzen Vector Tiles service is built from the [Tilezen](https://github.com/tilezen) open-source project.
 34 | 
 35 | ### Mapzen Terrain Tiles
 36 | 
 37 | [Mapzen Terrain Tiles](https://mapzen.com/documentation/terrain-tiles/) provides global elevation coverage and there are no rate limits.
 38 | 
 39 | The Mapzen Terrain Tiles service is built from the [Joerd](https://github.com/tilezen/joerd) open-source project.
 40 | 
 41 | ## Search and mobility products
 42 | 
 43 | ### Mapzen Search
 44 | 
 45 | [Mapzen Search](https://mapzen.com/documentation/search/) is a geocoding and place-finding service. The service has these limits:
 46 | 
 47 | - 25,000 free requests per month for forward geocoding, reverse geocoding, and place lookup
 48 | - 50,000 free requests per month for autocomplete
 49 | 
 50 | The Mapzen Search service is built from the [Pelias](https://github.com/pelias) open-source project.
 51 | 
 52 | ### Mapzen Turn-by-Turn
 53 | 
 54 | [Mapzen Turn-by-Turn](https://mapzen.com/documentation/turn-by-turn/) is a routing and navigation service. The service has these limits:
 55 | 
 56 | - 5,000 free requests per month
 57 | - Pedestrian routes have a limit of 50 locations and 250 kilometers.
 58 | - Bicycle routes have a limit of 50 locations and 500 kilometers.
 59 | - Automobile routes have a limit of 20 locations and 5,000 kilometers.
 60 | - Multimodal routes have a limit of 500 kilometers between locations.
 61 | 
 62 | The distance limit is the total straight-line distance (colloquially, as the crow flies) along a path through successive locations.
 63 | 
 64 | ### Mapzen Matrix
 65 | 
 66 | [Mapzen Matrix](https://mapzen.com/documentation/matrix/) provides time and distance calculations between locations. The service has these limits:
 67 | 
 68 | - 1,000 free requests per month
 69 | - The maximum number of locations is 50 for any type of matrix.
 70 | - The maximum straight-line distance between two locations is 400 kilometers for automobiles and similar transportation modes, and 200 kilometers for other options.
 71 | 
 72 | ### Mapzen Optimized Route
 73 | 
 74 | [Mapzen Optimized Route](https://mapzen.com/documentation/optimized/) finds the most efficient route between many locations. The service has these limits:
 75 | 
 76 | - 100 free requests per month
 77 | - The maximum number of locations is 50.
 78 | - The maximum straight-line distance between two locations is 200 kilometers.
 79 | 
 80 | ### Mapzen Isochrone
 81 | 
 82 | [Mapzen Isochrone](https://mapzen.com/documentation/mobility/isochrone/api-reference/) provides a computation of areas that are reachable within specified time periods from a location or set of locations. The service has these limits:
 83 | 
 84 | - 100 free requests per month
 85 | - The maximum number of locations is one. For isochrones around multiple locations, you need to make multiple requests.
 86 | - The maximum time to compute isochrone contours from the location is 120 minutes.
 87 | - The maximum number of isochrone contours in a single request is four.
 88 | 
 89 | ### Mapzen Map Matching
 90 | 
 91 | [Mapzen Map Matching](https://mapzen.com/documentation/mobility/map-matching/api-reference/) matches coordinates to known roads so you can turn a path into a route with narrative instructions and get the attribute values from that matched line. The service has these limits:
 92 | 
 93 | - 1,000 free requests per month
 94 | - The maximum input shape distance is 200 kilometers when using the `map_snap` shape match and 1,000 kilometers when using the `edge_walk` shape match.
 95 | - The maximum number of input shape points is 16,000.
 96 | - The maximum input GPS accuracy is 100 meters.
 97 | - The maximum upper bounds of the search radius is 100 meters.
 98 | 
 99 | The Mapzen Mobility services are built from the [Valhalla](https://github.com/valhalla) open-source project.
100 | 
101 | ## Data products
102 | 
103 | ### Mapzen Elevation
104 | 
105 | [Mapzen Elevation](https://mapzen.com/documentation/elevation/) provides the height or elevation at a set of locations. The service has these limits:
106 | 
107 | - 5,000 free requests per month
108 | 
109 | There are also limitations on the number of sampling points for which you request elevations.
110 | 
111 | The Mapzen Elevation lookup service is built from the [Joerd](https://github.com/tilezen/joerd) open-source project.
112 | 
113 | ### Mapzen Places
114 | 
115 | [Mapzen Places](https://mapzen.com/documentation/places/) provides administrative boundaries and hierarchies, neighbourhoods, postal codes, venues, and more from the [Who's On First](https://whosonfirst.mapzen.com/) dataset. The service has these limits:
116 | 
117 | - 25,000 free requests per month
118 | 
119 | ### Libpostal address parsing
120 | 
121 | [Libpostal API](https://mapzen.com/documentation/libpostal/) parses and normalizes street addresses. The service has these limits:
122 | 
123 | - 1,000 free requests per month
124 | 
125 | ### Other data products
126 | 
127 | Mapzen's other data products do not currently require API keys. These include:
128 | 
129 | - [Metro Extracts](https://mapzen.com/data/metro-extracts/), downloadable snapshots of OpenStreetMap data (Note: you will need to sign in with a developer account to download custom extracts)
130 | - [Transitland](https://transit.land/), the open transit data project
131 | 
132 | ## Mobile products
133 | 
134 | To use Mapzen's [Android](https://mapzen.com/documentation/android/) or [iOS](https://mapzen.com/documentation/ios/) SDKs or any of Mapzen's other products in your mobile apps, you need an API key. You are subject to the rate limits for the Mapzen service you are integrating in your app.
135 | 


--------------------------------------------------------------------------------
/docs/overview/support.md:
--------------------------------------------------------------------------------
 1 | # Get more help
 2 | 
 3 | Mapzen has many ways for you to get more help, and wants to hear from you. You can send a note about your bill, bugs or unexpected results, enhancement requests for future development, projects you have built with Mapzen, or any other questions you might have.
 4 | 
 5 | All users of Mapzen services have access to standard email support. Premium support with a service-level agreement is available for an additional [monthly fee](https://mapzen.com/pricing/#premium-support), and you can subscribe even if you are within the free rate limits of Mapzen’s products. Premium support users receive priority response times, usually within one business day. You can enable [premium support](account-settings.md#enable-premium-support) in your account settings.
 6 | 
 7 | ## Read documentation and blog posts
 8 | 
 9 | You can get self-service help at any time from Mapzen's [technical documentation](https://mapzen.com/documentation/) and [blog](https://mapzen.com/blog/).
10 | 
11 | Click the `Documentation` link at the top of any page on Mapzen's site to get to the help system. Documentation includes a variety of content, including comprehensive developer API reference, tutorials, glossaries, and conceptual overviews. If you want to help other users by making a correction or addition, each page has a button at the bottom (`Edit this page on GitHub`) that takes you to the source file.
12 | 
13 | The Mapzen blog is the home for Mapzen news, including announcements, engineering deep-dives, and product showcases and case studies. The blog posts and other company news are rolled into a monthly email newsletter. Sign up: https://mapzen.com/newsletter-signup/.
14 | 
15 | ## Contact Mapzen by email
16 | 
17 | Mapzen's main technical support email address is support@mapzen.com. Check in about anything you need, such as APIs, workflow guidance, and rate limits. The questions you ask to improve the technical documentation so the answer is easier to find for the next person who has the same problem.
18 | 
19 | If you need help with a technical issue, please include any details necessary to investigate your report. This can include concise instructions to reproduce the problem, the behavior you expected compared to what you saw, code samples, and screenshots.
20 | 
21 | ## Contact Mapzen from within your dashboard
22 | 
23 | If you are signed in, you can use a web form to send a question or feedback to Mapzen. Be sure to include your correct email address for a response.
24 | 
25 | 1. Sign in to your Mapzen account.
26 | 2. In the top corner of the page, click `Account` and click `Dashboard`.
27 | 3. Click the `Support` button in the bottom corner, fill in the form, and submit it.
28 | 
29 | ## Connect with the Mapzen developer community
30 | 
31 | ### Social media
32 | 
33 | Mapzen loves hearing from you on social media. Follow [@mapzen](https://twitter.com/mapzen) to be the first to know about Mapzen announcements, and tweet your questions and links to the interesting work you are doing with Mapzen's products. Mapzen also has pages on [Facebook](https://www.facebook.com/gomapzen), [LinkedIn](https://www.linkedin.com/company/mapzen), and other sites.
34 | 
35 | ### GitHub and community chat
36 | 
37 | If you are working with the code for Mapzen's open-source projects, you might be more comfortable communicating with through [GitHub](https://github.com). GitHub is the collaborative version control system Mapzen uses to manage code and documentation. Posting an issue lets engineers and other users know about a bug or software enhancement directly.
38 | 
39 | [Gitter](https://gitter.im) is an instant message chat system for GitHub users. Some of Mapzen's development teams have set up chat rooms associated with Mapzen's open-source projects so you can communicate with staff and the community in near real time.
40 | 
41 | - [Pelias](https://gitter.im/pelias/pelias) for geographic search and geocoding
42 | - [Tangram](https://gitter.im/tangrams/tangram-chat) for the map-drawing engine
43 | - [Tilezen](https://gitter.im/tilezen/tilezen-chat) for vector tiles and map data
44 | 
45 | If you have questions about running your own instance of Mapzen's open-source projects, GitHub and Gitter are your best options.
46 | 
47 | Another option for community chat is the #mapzen channel in [The Spatial Community](http://thespatialcommunity.org/), an online chat with thousands of geospatial enthusiasts as members.  
48 | 
49 | ### Events at Mapzen offices
50 | 
51 | If you are near a Mapzen office in the New York or San Francisco area, Mapzen occasionally hosts community events. In addition, Mapzen regularly offers office hours, where you can get personalized technical assistance and training and meet other users. Dates and times are usually announced on the [@mapzen](https://twitter.com/mapzen) Twitter account and in the [email newsletter](https://mapzen.com/newsletter-signup/).
52 | 


--------------------------------------------------------------------------------
/extract-tarball-url.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 | import json, sys, pipes
3 | 
4 | input = json.load(sys.stdin)
5 | value = input.get('tarball_url', '')
6 | output = pipes.quote(value)
7 | 
8 | print(output)
9 | 


--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
 1 | mkdocs==0.15.2
 2 | Pygments==2.1.1
 3 | htmlmin==0.1.10
 4 | mdx-outline==1.2.1
 5 | libsass==0.10.1
 6 | anyconfig==0.4.0
 7 | awscli==1.10.5
 8 | https://github.com/facelessuser/pymdown-extensions/archive/1.0.0.zip
 9 | beautifulsoup4==4.4.1
10 | PyYAML==3.11
11 | 


--------------------------------------------------------------------------------
/run-checklist.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | from bs4 import BeautifulSoup
  3 | from urllib.parse import urlparse, urlunparse, urljoin
  4 | from os.path import join, abspath, dirname, relpath, isdir, isfile
  5 | from re import compile
  6 | import unittest, yaml
  7 | 
  8 | class HTTP404 (RuntimeError): pass
  9 | 
 10 | class SoupServer:
 11 |     ''' Stupidest possible directory server thing.
 12 |     '''
 13 |     def __init__(self, base):
 14 |         self.base = abspath(base)
 15 |         self.url = '/'
 16 | 
 17 |     def go(self, path):
 18 |         path = urljoin(self.url, path)
 19 |         local = join(self.base, relpath(path, '/'))
 20 | 
 21 |         if isdir(local):
 22 |             local = join(local, 'index.html')
 23 | 
 24 |         if not isfile(local):
 25 |             raise HTTP404(path)
 26 | 
 27 |         with open(local) as file:
 28 |             soup = BeautifulSoup(file, "html.parser")
 29 | 
 30 |         path = relpath(local, self.base)
 31 |         self.url = '/' + path
 32 |         return soup
 33 | 
 34 | class Tests (unittest.TestCase):
 35 | 
 36 |     def setUp(self):
 37 |         self.server = SoupServer(join(dirname(__file__), 'dist'))
 38 | 
 39 |     def _load_doc_titles(self, path):
 40 |         '''
 41 |         '''
 42 |         with open(path) as file:
 43 |             config = yaml.load(file)
 44 |             site_name = config['site_name']
 45 |             has_more_pages = bool(len(config['pages']) > 1)
 46 |             has_next_prev = (config.get('include_next_prev') is not False)
 47 | 
 48 |             if has_more_pages and has_next_prev:
 49 |                 (page2_title, ) = config['pages'][1].keys()
 50 |             else:
 51 |                 page2_title = None
 52 | 
 53 |         return site_name, page2_title
 54 | 
 55 |     def _test_doc_section(self, start_path, start_title, next_title):
 56 |         '''
 57 |         '''
 58 |         page1 = self.server.go(start_path)
 59 |         url1 = self.server.url
 60 | 
 61 |         head1 = page1.find(class_=compile(r'\bdocumentation-hero\b')).find('h1')
 62 |         self.assertEqual(head1.text, start_title, 'Should be looking at {} page at {}'.format(start_title, self.server.url))
 63 | 
 64 |         crumbs1 = page1.find('ol', class_=compile(r'\bbreadcrumb\b')).find_all('li')
 65 |         self.assertEqual(len(crumbs1), 2, 'There should be two breadcrumbs at top at {}'.format(self.server.url))
 66 |         self.assertIsNotNone(crumbs1[0].find('a'), 'The first breadcrumb is a link at {}'.format(self.server.url))
 67 |         self.assertIsNone(crumbs1[1].find('a'), 'The last breadcrumb is not a link at {}'.format(self.server.url))
 68 |         self.assertEqual(crumbs1[1].text, start_title, 'The last breadcrumb should be {} at {}'.format(start_title, self.server.url))
 69 | 
 70 |         anchor1a = page1.find('footer').find(string=compile(r'Documentation')).find_parent('a')
 71 |         anchor1b = page1.find('footer').find(string=compile(r'GitHub')).find_parent('a')
 72 |         href1a = urljoin(urljoin('https://mapzen.com/documentation/', self.server.url), anchor1a['href'])
 73 |         href1b = urljoin(urljoin('https://mapzen.com/documentation/', self.server.url), anchor1b['href'])
 74 |         self.assertEqual(href1a, 'https://mapzen.com/documentation/', 'Should link to Mapzen docs')
 75 |         self.assertEqual(href1b, 'https://github.com/mapzen/', 'Should link out to Github')
 76 | 
 77 |         link1 = page1.find('a', class_=compile(r'\bpagination-link\b'))
 78 | 
 79 |         if next_title is None:
 80 |             self.assertIsNone(link1, 'Should be no pagination link at {}'.format(self.server.url))
 81 |             return
 82 | 
 83 |         self.assertIn(next_title, link1.text, 'First pagination link should go to {} from {}'.format(next_title, self.server.url))
 84 | 
 85 |         page2 = self.server.go(link1['href'])
 86 | 
 87 |         head2 = page1.find(class_=compile(r'\bdocumentation-hero\b')).find('h1')
 88 |         self.assertIn(start_title, head2.text, 'We should be on a page called {} at {}'.format(start_title, self.server.url))
 89 | 
 90 |         crumbs2 = page2.find('ol', class_=compile(r'\bbreadcrumb\b')).find_all('li')
 91 |         self.assertEqual(len(crumbs2), 3, 'There should be three breadcrumbs at top at {}'.format(self.server.url))
 92 |         self.assertIsNotNone(crumbs2[0].find('a'), 'The first breadcrumb is a link at {}'.format(self.server.url))
 93 |         self.assertIsNotNone(crumbs2[1].find('a'), 'The second breadcrumb is a link at {}'.format(self.server.url))
 94 |         self.assertIsNone(crumbs2[2].find('a'), 'The last breadcrumb is not a link at {}'.format(self.server.url))
 95 |         self.assertEqual(crumbs2[2].text, next_title, 'The last breadcrumb should be {} at {}'.format(next_title, self.server.url))
 96 | 
 97 |         edit2 = page2.find(string=compile(r'Edit this page on GitHub')).find_parent('a')
 98 | 
 99 |         self.assertEqual(urlparse(edit2['href']).hostname, 'github.com', 'Should link to Github.com from {}'.format(self.server.url))
100 |         self.assertTrue(urlparse(edit2['href']).path.endswith('.md'), 'Should link to a Markdown file from {}'.format(self.server.url))
101 | 
102 |         link2 = page2.find('a', class_=compile(r'\bpagination-link\b'))
103 |         self.server.go(link2['href'])
104 | 
105 |         self.assertEqual(self.server.url, url1, 'We should be back where we started')
106 | 
107 |     #def test_index(self):
108 |         # Disabling index page test while experimenting with new index
109 |         # page = self.server.go('/')
110 | 
111 |         # hitboxes = page.find('div', class_='doc-hitboxes').find_all('div', class_='doc-hitbox')
112 |         # self.assertEqual(len(hitboxes), 8, 'Should be eight documentation sections')
113 | 
114 |         # anchors = [box.find('a') for box in hitboxes]
115 |         # titles = [anchor.find('h5').text.strip() for anchor in anchors]
116 | 
117 |         # base = 'https://mapzen.com/documentation/'
118 |         # links = {urljoin(base, a['href']): t for (a, t) in zip(anchors, titles)}
119 | 
120 |         # self.assertEqual(links['https://mapzen.com/documentation/tangram/'], 'Tangram')
121 |         # self.assertEqual(links['https://mapzen.com/documentation/search/'], 'Mapzen Search')
122 |         # self.assertEqual(links['https://mapzen.com/documentation/turn-by-turn/'], 'Mapzen Turn-by-Turn')
123 |         # self.assertEqual(links['https://mapzen.com/documentation/vector-tiles/'], 'Vector Tile Service')
124 |         # self.assertEqual(links['https://mapzen.com/documentation/metro-extracts/'], 'Metro Extracts')
125 |         # self.assertEqual(links['https://mapzen.com/documentation/elevation/'], 'Elevation Service')
126 |         # self.assertEqual(links['https://mapzen.com/documentation/matrix/'], 'Time-Distance Matrix')
127 |         # self.assertEqual(links['https://mapzen.com/documentation/optimized/'], 'Optimized Route')
128 |         # self.assertEqual(links['https://mapzen.com/documentation/android/'], 'Android SDK')
129 |         # self.assertEqual(links['https://mapzen.com/documentation/mobility/'], 'Mobility')
130 |         # self.assertEqual(links['https://mapzen.com/documentation/overview/'], 'Overview')
131 | 
132 |     def test_tangram_index(self):
133 |         pass # self._test_doc_section('/tangram', *self._load_doc_titles('config/tangram.yml'))
134 | 
135 |     def test_search_index(self):
136 |         self._test_doc_section('/search', *self._load_doc_titles('config/search.yml'))
137 | 
138 |     # def test_turnbyturn_index(self):
139 |     #     self._test_doc_section('/turn-by-turn', *self._load_doc_titles('config/turn-by-turn.yml'))
140 |     def test_cartography_index(self):
141 |         self._test_doc_section('/cartography', *self._load_doc_titles('config/cartography.yml'))
142 | 
143 |     def test_vectortiles_index(self):
144 |         self._test_doc_section('/vector-tiles', *self._load_doc_titles('config/vector-tiles.yml'))
145 | 
146 |     def test_metroextracts_index(self):
147 |         self._test_doc_section('/metro-extracts', *self._load_doc_titles('config/metro-extracts.yml'))
148 | 
149 |     def test_mobility_index(self):
150 |         self._test_doc_section('/mobility', *self._load_doc_titles('config/mobility.yml'))
151 | 
152 |     def test_elevation_index(self):
153 |         self._test_doc_section('/elevation', *self._load_doc_titles('config/elevation.yml'))
154 | 
155 |     # def test_matrix_index(self):
156 |     #     self._test_doc_section('/matrix', *self._load_doc_titles('config/matrix.yml'))
157 |     #
158 |     # def test_optimized_index(self):
159 |     #     self._test_doc_section('/optimized', *self._load_doc_titles('config/optimized.yml'))
160 | 
161 |     def test_android_index(self):
162 |         self._test_doc_section('/android', *self._load_doc_titles('config/android.yml'))
163 | 
164 |     def test_ios_index(self):
165 |         self._test_doc_section('/ios', *self._load_doc_titles('config/ios.yml'))
166 | 
167 |     def test_ios_index(self):
168 |         self._test_doc_section('/libpostal', *self._load_doc_titles('config/libpostal.yml'))
169 | 
170 |     def test_mapzenjs_index(self):
171 |         self._test_doc_section('/mapzen-js', *self._load_doc_titles('config/mapzen-js.yml'))
172 | 
173 |     def test_overview_index(self):
174 |         self._test_doc_section('/overview', *self._load_doc_titles('config/overview.yml'))
175 | 
176 |     def test_guides_index(self):
177 |         self._test_doc_section('/guides', *self._load_doc_titles('config/guides.yml'))
178 | 
179 |     def test_places_index(self):
180 |         self._test_doc_section('/places', *self._load_doc_titles('config/places.yml')) 
181 | 
182 | if __name__ == '__main__':
183 |     unittest.main()
184 | 


--------------------------------------------------------------------------------
/runtime.txt:
--------------------------------------------------------------------------------
1 | python-3.5.1
2 | 


--------------------------------------------------------------------------------
/setup-redirects.py:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env python
 2 | from urllib.parse import urljoin
 3 | from os.path import join, dirname, exists
 4 | from os import makedirs
 5 | import yaml, argparse
 6 | 
 7 | template = '''<!DOCTYPE html>
 8 | <meta charset="utf-8">
 9 | <title>Redirecting...</title>
10 | <link rel="canonical" href="{href}">
11 | <meta http-equiv="refresh" content="0; url={href}">
12 | <h1>Redirecting...</h1>
13 | <a href="{href}">Click here if you are not redirected.</a>
14 | <script>location="{href}"</script>
15 | '''
16 | 
17 | def setup_redirect(old_path, new_href):
18 |     if exists(old_path):
19 |         print('Will not overwrite', old_path)
20 |         return
21 |     
22 |     if not exists(dirname(old_path)):
23 |         makedirs(dirname(old_path))
24 |     
25 |     with open(old_path, 'w') as output:
26 |         output.write(template.format(href=new_href))
27 | 
28 |     print('Redirecting from', old_path, 'to', new_href)
29 | 
30 | parser = argparse.ArgumentParser(description='Prepare some redirects.')
31 | parser.add_argument('config', help='Configuration file path')
32 | parser.add_argument('base', help='Output documentation base path')
33 | 
34 | if __name__ == '__main__':
35 |     args = parser.parse_args()
36 |     
37 |     with open(args.config) as input:
38 |         config = yaml.safe_load(input)
39 |         site_dir = config.get('site_dir')
40 |         
41 |         for (old_name, new_name) in config.get('mz:redirects', {}).items():
42 |             old_path = join(site_dir, old_name, 'index.html')
43 |             new_href = urljoin(args.base, new_name)
44 |             setup_redirect(old_path, new_href)
45 | 


--------------------------------------------------------------------------------
/setup-renames.py:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env python
 2 | from os.path import join, dirname, exists, isdir
 3 | from os import makedirs
 4 | from shutil import move
 5 | import yaml, argparse
 6 | 
 7 | def setup_rename(old_path, new_path):
 8 |     if isdir(old_path):
 9 |         print('Will not rename a whole directory')
10 |         return
11 | 
12 |     if exists(new_path):
13 |         print('Will not overwrite', new_path)
14 |         return
15 |     
16 |     if not exists(dirname(new_path)):
17 |         makedirs(dirname(new_path))
18 |     
19 |     move(old_path, new_path)
20 | 
21 | parser = argparse.ArgumentParser(description='Prepare some renames.')
22 | parser.add_argument('config', help='Configuration file path')
23 | 
24 | if __name__ == '__main__':
25 |     args = parser.parse_args()
26 |     
27 |     with open(args.config) as input:
28 |         config = yaml.safe_load(input)
29 |         site_dir = config.get('docs_dir')
30 |         
31 |         for (old_name, new_name) in config.get('mz:renames', {}).items():
32 |             print(old_name, '-->', new_name)
33 |             old_path = join(site_dir, old_name)
34 |             new_path = join(site_dir, new_name)
35 |             print(old_path, '==>', new_path)
36 |             setup_rename(old_path, new_path)
37 | 


--------------------------------------------------------------------------------
/src-index/index.md:
--------------------------------------------------------------------------------
  1 | <div class="container" id="content">
  2 | 	<div class="row headroom-large footroom-large">
  3 | 		<div class="col-xs-12 text-center">
  4 | 			<h1 class="red-text">
  5 | 				documentation
  6 | 			</h1>
  7 | 		</div>
  8 | 	</div>
  9 | 	<div class="row">
 10 | 		<div class="col-xs-12 footroom-large">
 11 | 			<h3 class="category-title">
 12 | 				General
 13 | 			</h3>
 14 | 			<div class="category-info-container first">
 15 | 				<div class="category-info">
 16 | 					<a class="docs-title" href="overview/">Get started</a>
 17 | 					<p class="excerpt">
 18 | 						Get started developing on the Mapzen platform by setting up your account, API keys, and billing information.
 19 | 					</p>
 20 | 				</div>
 21 | 				<div class="read-more">
 22 | 					<a class="btn btn-default btn-transparent" href="overview/"> View Documentation </a>
 23 | 				</div>
 24 | 			</div>
 25 | 			<div class="category-info-container">
 26 | 				<div class="category-info">
 27 | 					<a class="docs-title" href="guides/">Developer guides</a>
 28 | 					<p class="excerpt">
 29 | 						Set up your development environment with these general guides.
 30 | 					</p>
 31 | 				</div>
 32 | 				<div class="read-more">
 33 | 					<a class="btn btn-default btn-transparent" href="guides/"> View Documentation </a>
 34 | 				</div>
 35 | 			</div>
 36 | 		</div>
 37 | 	</div>
 38 | 	<div class="row">
 39 | 		<div class="col-xs-12 footroom-large">
 40 | 			<h3 class="category-title">
 41 | 				Maps
 42 | 			</h3>
 43 | 			<div class="category-info-container first">
 44 | 				<div class="category-info">
 45 | 					<a class="docs-title" href="mapzen-js/">mapzen.js</a>
 46 | 					<p class="excerpt">
 47 | 						Get everything you need to use Mapzen services in your web applications.
 48 | 					</p>
 49 | 				</div>
 50 | 				<div class="read-more">
 51 | 					<a class="btn btn-default btn-transparent" href="mapzen-js/"> View Documentation </a>
 52 | 				</div>
 53 | 			</div>
 54 | 			<div class="category-info-container">
 55 | 				<div class="category-info">
 56 | 					<a class="docs-title" href="cartography/">Cartography</a>
 57 | 					<p class="excerpt">
 58 | 						Get everything you need to use Mapzen basemaps and icons in your applications.
 59 | 					</p>
 60 | 				</div>
 61 | 				<div class="read-more">
 62 | 					<a class="btn btn-default btn-transparent" href="cartography/"> View Documentation </a>
 63 | 				</div>
 64 | 			</div>
 65 | 			<div class="category-info-container">
 66 | 				<div class="category-info">
 67 | 					<a class="docs-title" href="tangram/">Tangram</a>
 68 | 					<p class="excerpt">
 69 | 						Render 2D and 3D maps with fine control over the map-making process.
 70 | 					</p>
 71 | 				</div>
 72 | 				<div class="read-more">
 73 | 					<a class="btn btn-default btn-transparent" href="tangram/"> View Documentation </a>
 74 | 				</div>
 75 | 			</div>
 76 | 			<div class="category-info-container">
 77 | 				<div class="category-info">
 78 | 					<a class="docs-title" href="vector-tiles/">Vector tiles</a>
 79 | 					<p class="excerpt">
 80 | 						Display the world with the latest open data using vector tiles.
 81 | 					</p>
 82 | 				</div>
 83 | 				<div class="read-more">
 84 | 					<a class="btn btn-default btn-transparent" href="vector-tiles/"> View Documentation </a>
 85 | 				</div>
 86 | 			</div>
 87 | 			<div class="category-info-container">
 88 | 				<div class="category-info">
 89 | 					<a class="docs-title" href="terrain-tiles/">Terrain tiles</a>
 90 | 					<p class="excerpt">
 91 | 						Add open elevation data to your applications with raster terrain tiles.
 92 | 					</p>
 93 | 				</div>
 94 | 				<div class="read-more">
 95 | 					<a class="btn btn-default btn-transparent" href="terrain-tiles/"> View Documentation </a>
 96 | 				</div>
 97 | 			</div>
 98 | 		</div>
 99 | 		<div class="col-xs-12 footroom-large">
100 | 			<h3 class="category-title">
101 | 				Search & Mobility
102 | 			</h3>
103 | 			<div class="category-info-container first">
104 | 				<div class="category-info">
105 | 					<a class="docs-title" href="search/">Mapzen Search</a>
106 | 					<p class="excerpt">
107 | 						Find places and addresses with this geographic search service.
108 | 					</p>
109 | 				</div>
110 | 				<div class="read-more">
111 | 					<a class="btn btn-default btn-transparent" href="search/"> View Documentation </a>
112 | 				</div>
113 | 			</div>
114 | 			<div class="category-info-container">
115 | 				<div class="category-info">
116 | 					<a class="docs-title" href="mobility/">Mapzen Mobility</a>
117 | 					<p class="excerpt">
118 | 						Add planetwide routing and navigation to your web and mobile applications.
119 | 					</p>
120 | 				</div>
121 | 				<div class="read-more">
122 | 					<a class="btn btn-default btn-transparent" href="mobility/"> View Documentation </a>
123 | 				</div>
124 | 			</div>
125 | 		</div>
126 | 		<div class="col-xs-12 footroom-large">
127 | 			<h3 class="category-title">
128 | 				Data
129 | 			</h3>
130 | 			<div class="category-info-container first">
131 | 				<div class="category-info">
132 | 					<a class="docs-title" href="places/">Mapzen Places</a>
133 | 					<p class="excerpt">
134 | 						Get administrative boundaries and hierarchies, neighbourhoods, postal codes, venues, and more.
135 | 					</p>
136 | 				</div>
137 | 				<div class="read-more">
138 | 					<a class="btn btn-default btn-transparent" href="places/"> View Documentation </a>
139 | 				</div>
140 | 			</div>
141 | 			<div class="category-info-container">
142 | 				<div class="category-info">
143 | 					<a class="docs-title" href="metro-extracts/">Metro Extracts</a>
144 | 					<p class="excerpt">
145 | 						Download manageable, city-sized portions of OpenStreetMap data.
146 | 					</p>
147 | 				</div>
148 | 				<div class="read-more">
149 | 					<a class="btn btn-default btn-transparent" href="metro-extracts/"> View Documentation </a>
150 | 				</div>
151 | 			</div>
152 | 			<div class="category-info-container">
153 | 				<div class="category-info">
154 | 					<a class="docs-title" href="elevation/">Elevation Service</a>
155 | 					<p class="excerpt">
156 | 						Request digital elevation model (DEM) data from around the world.
157 | 					</p>
158 | 				</div>
159 | 				<div class="read-more">
160 | 					<a class="btn btn-default btn-transparent" href="elevation/"> View Documentation </a>
161 | 				</div>
162 | 			</div>
163 | 			<div class="category-info-container">
164 | 				<div class="category-info">
165 | 					<a class="docs-title" href="libpostal/">Address Parsing</a>
166 | 					<p class="excerpt">
167 | 						Parse and expand address data with the libpostal engine.
168 | 					</p>
169 | 				</div>
170 | 				<div class="read-more">
171 | 					<a class="btn btn-default btn-transparent" href="libpostal/"> View Documentation </a>
172 | 				</div>
173 | 			</div>
174 | 		</div>
175 | 		<div class="col-xs-12 footroom-large">
176 | 			<h3 class="category-title">
177 | 				Mobile
178 | 			</h3>
179 | 			<div class="category-info-container first">
180 | 				<div class="category-info">
181 | 					<a class="docs-title" href="android/">Android SDK</a>
182 | 					<p class="excerpt">
183 | 						Add Mapzen maps and location services to your Android apps.
184 | 					</p>
185 | 				</div>
186 | 				<div class="read-more">
187 | 					<a class="btn btn-default btn-transparent" href="android/"> View Documentation </a>
188 | 				</div>
189 | 			</div>
190 | 				<div class="category-info-container">
191 | 					<div class="category-info">
192 | 						<a class="docs-title" href="ios/">iOS SDK</a>
193 | 						<p class="excerpt">
194 | 							Add Mapzen maps and location services to your iOS apps.
195 | 						</p>
196 | 					</div>
197 | 					<div class="read-more">
198 | 						<a class="btn btn-default btn-transparent" href="ios/"> View Documentation </a>
199 | 					</div>
200 | 				</div>
201 | 			</div>
202 | 		</div>
203 | 	</div>
204 | </div>
205 | 


--------------------------------------------------------------------------------
/theme/base.html:
--------------------------------------------------------------------------------
  1 | <!DOCTYPE html>
  2 | <html lang='en'>
  3 |   <head>
  4 |     <meta charset='utf-8'>
  5 |     <meta http-equiv='X-UA-Compatible' content='IE=edge'>
  6 |     <meta name='viewport' content='width=device-width, initial-scale=1.0'>
  7 |     {% if page_description %}<meta name='description' content='{{ page_description }}'>{% endif %}
  8 |     {% if site_author %}<meta name='author' content='{{ site_author }}'>{% endif %}
  9 |     {% if canonical_url %}<link rel='canonical' href='{{ canonical_url }}'>{% endif %}
 10 |     <link rel='apple-touch-icon' href='https://mapzen.com/common/styleguide/images/favicons/apple-touch-icon.png' sizes='180x180'>
 11 |     <link rel='icon' type='image/png' href='https://mapzen.com/common/styleguide/images/favicons/favicon-16x16.png' sizes='16x16'>
 12 |     <link rel='icon' type='image/png' href='https://mapzen.com/common/styleguide/images/favicons/favicon-32x32.png' sizes='32x32'>
 13 |     <link rel='manifest' href='https://mapzen.com/common/styleguide/images/favicons/manifest.json'>
 14 |     <link rel='mask-icon' href='https://mapzen.com/common/styleguide/images/favicons/safari-pinned-tab.svg' color='#2C1E3F'>
 15 | 
 16 |     <title>{% if page_title %}{{ page_title }} - {% endif %}{{ site_name }}</title>
 17 | 
 18 |     <link rel='stylesheet' href='https://mapzen.com/common/styleguide/styles/documentation.min.css'>
 19 |     <link rel='stylesheet' href='{{ base_url }}/css/highlight.css'>
 20 |     {%- for path in extra_css %}
 21 |     <link href='{{ path }}' rel='stylesheet'>
 22 |     {%- endfor %}
 23 |   </head>
 24 | 
 25 |   <body{% if current_page and current_page.is_homepage %} class='homepage'{% endif %} data-spy='scroll' data-target='.toc' data-offset='10'>
 26 | 
 27 |     {% include 'fragments/global-nav.html' %}
 28 | 
 29 |     {% if config.extra.layout == 'raw-page' %}
 30 | 
 31 |       {{ content }}
 32 | 
 33 |     {% else %}
 34 | 
 35 |     <div class='documentation-hero'>
 36 |       <div class='container'>
 37 |         <div class='row'>
 38 |           <div class='col-xs-12 col-md-12'>
 39 |             <h1>{{ site_name }}</h1>
 40 |             {% if config.extra.site_subtitle %}<p>{{ config.extra.site_subtitle }}</p>{% endif %}
 41 |           </div>
 42 |         </div>
 43 |       </div>
 44 |     </div>
 45 | 
 46 |     <div class='container documentation-nav hidden-print'>
 47 |       <div class='row headroom'>
 48 |         <div class='col-xs-12 col-md-8'>
 49 |           {% include 'breadcrumbs.html' %}
 50 |         </div>
 51 |         <div class='col-xs-12 col-md-4'>
 52 |           {% include 'search-form.html' %}
 53 |         </div>
 54 |       </div>
 55 |     </div>
 56 | 
 57 |     <div class='container documentation-container'>
 58 |       <div class='row'>
 59 |       {% block content %}
 60 |         <div class='col-xs-12 col-md-3'>{% include 'toc.html' %}</div>
 61 |         <div class='col-xs-12 col-md-9' role='main'>
 62 |           <div class='documentation-content'>
 63 |             {% include 'content.html' %}
 64 |           </div>
 65 | 
 66 |           {% if include_next_prev %}
 67 |             <div class='pagination pagination-alt headroom'>
 68 |               {% if previous_page %}
 69 |                 <a class='pagination-link pagination-previous' rel='next' {% if previous_page %}href='{{ previous_page.url }}'{% endif %}>
 70 |                   <i class='fa fa-fw fa-angle-left'></i>
 71 |                   <span class='pagination-link-text'>{{ previous_page.title }}</span>
 72 |                 </a>
 73 |               {% endif %}
 74 | 
 75 |               {#
 76 |               <a class='pagination-link pagination-top' href='#'>
 77 |                 <i class='fa fa-fw fa-angle-up'></i>
 78 |                 <span class='pagination-link-text'>Top</span>
 79 |               </a>
 80 |               #}
 81 | 
 82 |               {% if next_page %}
 83 |                 <a class='pagination-link pagination-next' rel='prev' {% if next_page %}href='{{ next_page.url }}'{% endif %}>
 84 |                   <span class='pagination-link-text'>{{ next_page.title }}</span>
 85 |                   <i class='fa fa-fw fa-angle-right'></i>
 86 |                 </a>
 87 |               {% endif %}
 88 |             </div>
 89 |           {% endif %}
 90 | 
 91 |           {% if config.extra.docs_base_url %}
 92 |             <div class='documentation-edit headroom-large'>
 93 |               {# Look for Github sources in configured mz:renames #}
 94 |               {% for (github_path, local_path) in config.get('mz:renames', {}).items() if (local_path == current_page.input_path) %}
 95 |                 <!-- found {{ local_path }} renamed from {{ github_path }} -->
 96 |                 <a href='{{ config.extra.docs_base_url }}/{{ github_path }}'>
 97 |                   Edit this page on GitHub
 98 |                   <i class='fa fa-2x fa-fw fa-github'></i>
 99 |                 </a>
100 |               {% else %}
101 |                 <a href='{{ config.extra.docs_base_url }}/{{ current_page.input_path }}'>
102 |                   Edit this page on GitHub
103 |                   <i class='fa fa-2x fa-fw fa-github'></i>
104 |                 </a>
105 |               {% endfor %}
106 |             </div>
107 |           {% endif %}
108 | 
109 |         </div>
110 |       {% endblock %}
111 |       </div>
112 |     </div>
113 | 
114 |     <div class='container headroom-large footroom-large hidden-print'>
115 |       {% include 'common/cta.html' %}
116 |     </div>
117 | 
118 |     {% endif %}
119 | 
120 |     {% include 'fragments/global-footer.html' %}
121 | 
122 |     <script src='{{ base_url }}/js/jquery-1.10.2.min.js'></script>
123 |     <script src='{{ base_url }}/js/highlight.pack.js'></script>
124 |     <script>var base_url = '{{ base_url }}';</script>
125 |     <script src='{{ base_url }}/js/base.js'></script>
126 |     <script src='https://mapzen.com/common/styleguide/scripts/mapzen-styleguide.min.js'></script>
127 |     {%- for path in extra_javascript %}
128 |     <script src='{{ path }}'></script>
129 |     {%- endfor %}
130 | 
131 |   </body>
132 | </html>
133 | <!--
134 | MkDocs version : {{ mkdocs_version }}
135 | Build Date UTC : {{ build_date_utc }}
136 | Build date: {{ build_date_utc.strftime('%-d %B %Y') }}
137 | -->
138 | 


--------------------------------------------------------------------------------
/theme/breadcrumbs.html:
--------------------------------------------------------------------------------
 1 | <ol class='breadcrumb'>
 2 |   <li><a href='/documentation/'>Documentation</a></li>
 3 | 
 4 |   {# Top-level project breadcrumb. #}
 5 |   {# Is labeled 'active' if current page is project homepage. #}
 6 |   {# Creates link to project homepage if currently on a sub-page or nav is included. #}
 7 |   {% if current_page and current_page.is_homepage %}
 8 |     <li class='active'>{{ site_name }}</li>
 9 |   {% else %}
10 |     <li>{% if page_title or include_nav %}<a href='{{ homepage_url }}'>{% endif %}{{ site_name }}{% if page_title or include_nav %}</a>{% endif %}</li>
11 | 
12 |     {# Navigation category breadcrumb. #}
13 |     {% for nav_item in nav %}
14 |       {% if nav_item.active %}
15 |         <li class='active'>{{ nav_item.title }}</li>
16 | 
17 |         {# Sub-page breadcrumb. #}
18 |         {# Displays only if it exists. #}
19 |         {# Occurs inside this loop so it has access to nav_item.title #}
20 |         {% if page_title and page_title != nav_item.title %}
21 |           <li class='active'>{% if canonical_url %}<a href='{{ canonical_url }}'>{% endif %}{{ page_title }}{% if canonical_url %}</a>{% endif %}</li>
22 |         {% endif %}
23 | 
24 |       {% endif %}
25 |     {% endfor %}
26 |   {% endif %}
27 | 
28 | </ol>
29 | 


--------------------------------------------------------------------------------
/theme/common/cta.html:
--------------------------------------------------------------------------------
 1 | <div class='cta-container'>
 2 |   <div class='cta-text'>
 3 |     <p>
 4 |       Get your API key for access to Mapzen services.
 5 |     </p>
 6 |   </div>
 7 |   <div class='cta-btn'>
 8 |     <a href='/developers/' class='btn btn-mapzen'>Sign up</a>
 9 |   </div>
10 | </div>
11 | 


--------------------------------------------------------------------------------
/theme/css/codehilite/default.css:
--------------------------------------------------------------------------------
 1 | .codehilite .hll { background-color: #ffffcc }
 2 | .codehilite  { background: #f8f8f8; }
 3 | .codehilite .c { color: #408080; font-style: italic } /* Comment */
 4 | .codehilite .err { border: 1px solid #FF0000 } /* Error */
 5 | .codehilite .k { color: #008000; font-weight: bold } /* Keyword */
 6 | .codehilite .o { color: #666666 } /* Operator */
 7 | .codehilite .cm { color: #408080; font-style: italic } /* Comment.Multiline */
 8 | .codehilite .cp { color: #BC7A00 } /* Comment.Preproc */
 9 | .codehilite .c1 { color: #408080; font-style: italic } /* Comment.Single */
10 | .codehilite .cs { color: #408080; font-style: italic } /* Comment.Special */
11 | .codehilite .gd { color: #A00000 } /* Generic.Deleted */
12 | .codehilite .ge { font-style: italic } /* Generic.Emph */
13 | .codehilite .gr { color: #FF0000 } /* Generic.Error */
14 | .codehilite .gh { color: #000080; font-weight: bold } /* Generic.Heading */
15 | .codehilite .gi { color: #00A000 } /* Generic.Inserted */
16 | .codehilite .go { color: #808080 } /* Generic.Output */
17 | .codehilite .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
18 | .codehilite .gs { font-weight: bold } /* Generic.Strong */
19 | .codehilite .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
20 | .codehilite .gt { color: #0040D0 } /* Generic.Traceback */
21 | .codehilite .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
22 | .codehilite .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
23 | .codehilite .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
24 | .codehilite .kp { color: #008000 } /* Keyword.Pseudo */
25 | .codehilite .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
26 | .codehilite .kt { color: #B00040 } /* Keyword.Type */
27 | .codehilite .m { color: #666666 } /* Literal.Number */
28 | .codehilite .s { color: #BA2121 } /* Literal.String */
29 | .codehilite .na { color: #7D9029 } /* Name.Attribute */
30 | .codehilite .nb { color: #008000 } /* Name.Builtin */
31 | .codehilite .nc { color: #0000FF; font-weight: bold } /* Name.Class */
32 | .codehilite .no { color: #880000 } /* Name.Constant */
33 | .codehilite .nd { color: #AA22FF } /* Name.Decorator */
34 | .codehilite .ni { color: #999999; font-weight: bold } /* Name.Entity */
35 | .codehilite .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
36 | .codehilite .nf { color: #0000FF } /* Name.Function */
37 | .codehilite .nl { color: #A0A000 } /* Name.Label */
38 | .codehilite .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
39 | .codehilite .nt { color: #008000; font-weight: bold } /* Name.Tag */
40 | .codehilite .nv { color: #19177C } /* Name.Variable */
41 | .codehilite .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
42 | .codehilite .w { color: #bbbbbb } /* Text.Whitespace */
43 | .codehilite .mf { color: #666666 } /* Literal.Number.Float */
44 | .codehilite .mh { color: #666666 } /* Literal.Number.Hex */
45 | .codehilite .mi { color: #666666 } /* Literal.Number.Integer */
46 | .codehilite .mo { color: #666666 } /* Literal.Number.Oct */
47 | .codehilite .sb { color: #BA2121 } /* Literal.String.Backtick */
48 | .codehilite .sc { color: #BA2121 } /* Literal.String.Char */
49 | .codehilite .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
50 | .codehilite .s2 { color: #BA2121 } /* Literal.String.Double */
51 | .codehilite .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
52 | .codehilite .sh { color: #BA2121 } /* Literal.String.Heredoc */
53 | .codehilite .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
54 | .codehilite .sx { color: #008000 } /* Literal.String.Other */
55 | .codehilite .sr { color: #BB6688 } /* Literal.String.Regex */
56 | .codehilite .s1 { color: #BA2121 } /* Literal.String.Single */
57 | .codehilite .ss { color: #19177C } /* Literal.String.Symbol */
58 | .codehilite .bp { color: #008000 } /* Name.Builtin.Pseudo */
59 | .codehilite .vc { color: #19177C } /* Name.Variable.Class */
60 | .codehilite .vg { color: #19177C } /* Name.Variable.Global */
61 | .codehilite .vi { color: #19177C } /* Name.Variable.Instance */
62 | .codehilite .il { color: #666666 } /* Literal.Number.Integer.Long */
63 | 


--------------------------------------------------------------------------------
/theme/css/codehilite/mapzen.css:
--------------------------------------------------------------------------------
 1 | .codehilite .hll { background-color: #ffffcc }
 2 | /* .codehilite  { background: #f8f8f8; } */
 3 | .codehilite .c { color: #999988; font-style: italic } /* Comment */
 4 | .codehilite .err { color: #a61717; background-color: #e3d2d2 } /* Error */
 5 | .codehilite .k { font-weight: bold } /* Keyword */
 6 | .codehilite .o { font-weight: bold } /* Operator */
 7 | .codehilite .cm { color: #999988; font-style: italic } /* Comment.Multiline */
 8 | .codehilite .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
 9 | .codehilite .c1 { color: #999988; font-style: italic } /* Comment.Single */
10 | .codehilite .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
11 | .codehilite .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
12 | .codehilite .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */
13 | .codehilite .ge { font-style: italic } /* Generic.Emph */
14 | .codehilite .gr { color: #aa0000 } /* Generic.Error */
15 | .codehilite .gh { color: #999999 } /* Generic.Heading */
16 | .codehilite .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
17 | .codehilite .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */
18 | .codehilite .go { color: #888888 } /* Generic.Output */
19 | .codehilite .gp { color: #555555 } /* Generic.Prompt */
20 | .codehilite .gs { font-weight: bold } /* Generic.Strong */
21 | .codehilite .gu { color: #aaaaaa } /* Generic.Subheading */
22 | .codehilite .gt { color: #aa0000 } /* Generic.Traceback */
23 | .codehilite .kc { font-weight: bold } /* Keyword.Constant */
24 | .codehilite .kd { font-weight: bold } /* Keyword.Declaration */
25 | .codehilite .kp { font-weight: bold } /* Keyword.Pseudo */
26 | .codehilite .kr { font-weight: bold } /* Keyword.Reserved */
27 | .codehilite .kt { color: #445588; font-weight: bold } /* Keyword.Type */
28 | .codehilite .m { color: #009999 } /* Literal.Number */
29 | .codehilite .s { color: #d14 } /* Literal.String */
30 | .codehilite .na { color: #008080 } /* Name.Attribute */
31 | .codehilite .nb { color: #0086B3 } /* Name.Builtin */
32 | .codehilite .nc { color: #445588; font-weight: bold } /* Name.Class */
33 | .codehilite .no { color: #008080 } /* Name.Constant */
34 | .codehilite .ni { color: #800080 } /* Name.Entity */
35 | .codehilite .ne { color: #990000; font-weight: bold } /* Name.Exception */
36 | .codehilite .nf { color: #990000; font-weight: bold } /* Name.Function */
37 | .codehilite .nn { color: #555555 } /* Name.Namespace */
38 | .codehilite .nt { color: #000080 } /* Name.Tag */
39 | .codehilite .nv { color: #008080 } /* Name.Variable */
40 | .codehilite .ow { font-weight: bold } /* Operator.Word */
41 | .codehilite .w { color: #bbbbbb } /* Text.Whitespace */
42 | .codehilite .mf { color: #009999 } /* Literal.Number.Float */
43 | .codehilite .mh { color: #009999 } /* Literal.Number.Hex */
44 | .codehilite .mi { color: #009999 } /* Literal.Number.Integer */
45 | .codehilite .mo { color: #009999 } /* Literal.Number.Oct */
46 | .codehilite .sb { color: #d14 } /* Literal.String.Backtick */
47 | .codehilite .sc { color: #d14 } /* Literal.String.Char */
48 | .codehilite .sd { color: #d14 } /* Literal.String.Doc */
49 | .codehilite .s2 { color: #d14 } /* Literal.String.Double */
50 | .codehilite .se { color: #d14 } /* Literal.String.Escape */
51 | .codehilite .sh { color: #d14 } /* Literal.String.Heredoc */
52 | .codehilite .si { color: #d14 } /* Literal.String.Interpol */
53 | .codehilite .sx { color: #d14 } /* Literal.String.Other */
54 | .codehilite .sr { color: #009926 } /* Literal.String.Regex */
55 | .codehilite .s1 { color: #d14 } /* Literal.String.Single */
56 | .codehilite .ss { color: #990073 } /* Literal.String.Symbol */
57 | .codehilite .bp { color: #999999 } /* Name.Builtin.Pseudo */
58 | .codehilite .vc { color: #008080 } /* Name.Variable.Class */
59 | .codehilite .vg { color: #008080 } /* Name.Variable.Global */
60 | .codehilite .vi { color: #008080 } /* Name.Variable.Instance */
61 | .codehilite .il { color: #009999 } /* Literal.Number.Integer.Long */
62 | 


--------------------------------------------------------------------------------
/theme/css/codehilite/monokai.css:
--------------------------------------------------------------------------------
 1 | .codehilite .hll { background-color: #49483e }
 2 | .codehilite .c { color: #75715e } /* Comment */
 3 | .codehilite .err { color: #960050; background-color: #1e0010 } /* Error */
 4 | .codehilite .k { color: #66d9ef } /* Keyword */
 5 | .codehilite .l { color: #ae81ff } /* Literal */
 6 | .codehilite .n { color: #f8f8f2 } /* Name */
 7 | .codehilite .o { color: #f92672 } /* Operator */
 8 | .codehilite .p { color: #f8f8f2 } /* Punctuation */
 9 | .codehilite .cm { color: #75715e } /* Comment.Multiline */
10 | .codehilite .cp { color: #75715e } /* Comment.Preproc */
11 | .codehilite .c1 { color: #75715e } /* Comment.Single */
12 | .codehilite .cs { color: #75715e } /* Comment.Special */
13 | .codehilite .ge { font-style: italic } /* Generic.Emph */
14 | .codehilite .gs { font-weight: bold } /* Generic.Strong */
15 | .codehilite .kc { color: #66d9ef } /* Keyword.Constant */
16 | .codehilite .kd { color: #66d9ef } /* Keyword.Declaration */
17 | .codehilite .kn { color: #f92672 } /* Keyword.Namespace */
18 | .codehilite .kp { color: #66d9ef } /* Keyword.Pseudo */
19 | .codehilite .kr { color: #66d9ef } /* Keyword.Reserved */
20 | .codehilite .kt { color: #66d9ef } /* Keyword.Type */
21 | .codehilite .ld { color: #e6db74 } /* Literal.Date */
22 | .codehilite .m { color: #ae81ff } /* Literal.Number */
23 | .codehilite .s { color: #e6db74 } /* Literal.String */
24 | .codehilite .na { color: #a6e22e } /* Name.Attribute */
25 | .codehilite .nb { color: #f8f8f2 } /* Name.Builtin */
26 | .codehilite .nc { color: #a6e22e } /* Name.Class */
27 | .codehilite .no { color: #66d9ef } /* Name.Constant */
28 | .codehilite .nd { color: #a6e22e } /* Name.Decorator */
29 | .codehilite .ni { color: #f8f8f2 } /* Name.Entity */
30 | .codehilite .ne { color: #a6e22e } /* Name.Exception */
31 | .codehilite .nf { color: #a6e22e } /* Name.Function */
32 | .codehilite .nl { color: #f8f8f2 } /* Name.Label */
33 | .codehilite .nn { color: #f8f8f2 } /* Name.Namespace */
34 | .codehilite .nx { color: #a6e22e } /* Name.Other */
35 | .codehilite .py { color: #f8f8f2 } /* Name.Property */
36 | .codehilite .nt { color: #f92672 } /* Name.Tag */
37 | .codehilite .nv { color: #f8f8f2 } /* Name.Variable */
38 | .codehilite .ow { color: #f92672 } /* Operator.Word */
39 | .codehilite .w { color: #f8f8f2 } /* Text.Whitespace */
40 | .codehilite .mf { color: #ae81ff } /* Literal.Number.Float */
41 | .codehilite .mh { color: #ae81ff } /* Literal.Number.Hex */
42 | .codehilite .mi { color: #ae81ff } /* Literal.Number.Integer */
43 | .codehilite .mo { color: #ae81ff } /* Literal.Number.Oct */
44 | .codehilite .sb { color: #e6db74 } /* Literal.String.Backtick */
45 | .codehilite .sc { color: #e6db74 } /* Literal.String.Char */
46 | .codehilite .sd { color: #e6db74 } /* Literal.String.Doc */
47 | .codehilite .s2 { color: #e6db74 } /* Literal.String.Double */
48 | .codehilite .se { color: #ae81ff } /* Literal.String.Escape */
49 | .codehilite .sh { color: #e6db74 } /* Literal.String.Heredoc */
50 | .codehilite .si { color: #e6db74 } /* Literal.String.Interpol */
51 | .codehilite .sx { color: #e6db74 } /* Literal.String.Other */
52 | .codehilite .sr { color: #e6db74 } /* Literal.String.Regex */
53 | .codehilite .s1 { color: #e6db74 } /* Literal.String.Single */
54 | .codehilite .ss { color: #e6db74 } /* Literal.String.Symbol */
55 | .codehilite .bp { color: #f8f8f2 } /* Name.Builtin.Pseudo */
56 | .codehilite .vc { color: #f8f8f2 } /* Name.Variable.Class */
57 | .codehilite .vg { color: #f8f8f2 } /* Name.Variable.Global */
58 | .codehilite .vi { color: #f8f8f2 } /* Name.Variable.Instance */
59 | .codehilite .il { color: #ae81ff } /* Literal.Number.Integer.Long */
60 | 
61 | .codehilite .gh { } /* Generic Heading & Diff Header */
62 | .codehilite .gu { color: #75715e; } /* Generic.Subheading & Diff Unified/Comment? */
63 | .codehilite .gd { color: #f92672; } /* Generic.Deleted & Diff Deleted */
64 | .codehilite .gi { color: #a6e22e; } /* Generic.Inserted & Diff Inserted */
65 | 


--------------------------------------------------------------------------------
/theme/js/base.js:
--------------------------------------------------------------------------------
 1 | 
 2 | function getSearchTerm()
 3 | {
 4 |     var sPageURL = window.location.search.substring(1);
 5 |     var sURLVariables = sPageURL.split('&');
 6 |     for (var i = 0; i < sURLVariables.length; i++)
 7 |     {
 8 |         var sParameterName = sURLVariables[i].split('=');
 9 |         if (sParameterName[0] == 'q')
10 |         {
11 |             return sParameterName[1];
12 |         }
13 |     }
14 | }
15 | 
16 | $(document).ready(function () {
17 |   var search_term = getSearchTerm()
18 |   var $search_modal = $('#mkdocs_search_modal')
19 |   var $searchResults = $('#mkdocs-search-results')
20 |   var $searchInput = $('#mkdocs-search-query')
21 | 
22 |   if (search_term) {
23 |     $searchInput.val(search_term)
24 |   }
25 | 
26 |   var selectedPosition
27 | 
28 |   $searchInput.on('keyup', function (e) {
29 |     // Need to wait a bit for search function to finish populating our results
30 |     setTimeout(function () {
31 |       // See if anything is inside the search results
32 |       if ($.trim($searchResults.html()) !== '') {
33 |         $searchResults.show()
34 |         $searchResults.css('max-height', window.innerHeight - $searchResults[0].getBoundingClientRect().top - 100)
35 | 
36 |         var input = $searchInput.val().trim()
37 |         var list = $searchResults.find('article')
38 | 
39 |         if (list.length > 0) {
40 |           // var highlight = function (text, focus) {
41 |           //   var r = RegExp('(' + focus + ')', 'gi');
42 |           //   return text.replace(r, '<strong>$1</strong>');
43 |           // }
44 | 
45 |           // var html = $searchResults.html()
46 |           // $searchResults.html(highlight(html, input))
47 | 
48 |           // Now reapply selection
49 |           if (selectedPosition) {
50 |             list[selectedPosition].addClass('selected')
51 |           }
52 |         }
53 |       } else {
54 |         $searchResults.hide()
55 |       }
56 |     }, 0)
57 |   })
58 | 
59 |   $search_modal.on('blur', function () {
60 |     resetSearchResults();
61 |   })
62 |   $searchResults.on('click', 'article', function (e) {
63 |     findAndOpenLink(this);
64 |     // In case it just jumps down the page
65 |     resetSearchResults();
66 |   })
67 | 
68 |   function findAndOpenLink (articleEl) {
69 |     var link = $(articleEl).find('a').attr('href')
70 |     window.location.href = link;
71 |   }
72 | 
73 |   function resetSearchResults () {
74 |     $searchResults.empty();
75 |     $searchResults.hide();
76 |   }
77 | 
78 |   // Highlight.js
79 |   hljs.initHighlightingOnLoad();
80 | });
81 | 
82 | // Add the correct class to tables
83 | $('table').addClass('table');
84 | 
85 | /* Prevent disabled links from causing a page reload */
86 | $('li.disabled a').click(function(event) {
87 |   event.preventDefault();
88 | })
89 | 


--------------------------------------------------------------------------------
/theme/nav-sub.html:
--------------------------------------------------------------------------------
 1 | {% if not nav_item.children %}
 2 |   <li {% if nav_item.active %}class='toc-current'{% endif %}>
 3 |     <a href='{{ nav_item.url }}'>{{ nav_item.title }}</a>
 4 |     {% if nav_item.active %}
 5 |       {% include 'toc-sub.html' %}
 6 |     {% endif %}
 7 |   </li>
 8 | {% else %}
 9 |   <!-- This is when there is subcategory coming from config.yml -->
10 |   <li>
11 |     <a href='{% if nav_item.url %} {{nav_item.url}} {% else %} {{nav_item.children[0].url}} {% endif %} '> {{ nav_item.title }}</a>
12 |     <ul class='toc-subnav  {% if nav_item.active %} toc-expand {% endif %}'>
13 |       {% if nav_item.active %}
14 |         {% for nav_item in nav_item.children %}
15 |           <li class='main{% if nav_item.active %} toc-current{% endif %}'>
16 |             <a href='{{ nav_item.url }}'>{{nav_item.title}} </a>
17 |           </li>
18 |         {% endfor %}
19 |       {% endif %}
20 |     </ul>
21 |   </li>
22 | {% endif %}
23 | 
24 | 


--------------------------------------------------------------------------------
/theme/search-form.html:
--------------------------------------------------------------------------------
1 | <div id='mkdocs_search_modal' class='search-container' tabindex='-1' aria-labelledby='Search Modal' aria-hidden='true'>
2 |   <form action="https://www.google.com/search" method="get">
3 |     <div class="form-group inline-submit">
4 |       <input type="hidden" name="as_sitesearch" value="mapzen.com/documentation">
5 |       <input type="search" name="q" placeholder="search documentation" class="col-xs-8">
6 |       <input type="submit" class="btn btn-transparent col-xs-4" value="search">
7 |     </div>
8 |   </form>
9 | </div>


--------------------------------------------------------------------------------
/theme/search-modal.html:
--------------------------------------------------------------------------------
 1 |     <div class='modal' id='mkdocs_search_modal' tabindex='-1' role='dialog' aria-labelledby='Search Modal' aria-hidden='true'>
 2 |       <div class='modal-dialog'>
 3 |         <div class='modal-content'>
 4 |           <div class='modal-header'>
 5 |             <button type='button' class='close' data-dismiss='modal'><span aria-hidden='true'>&times;</span><span class='sr-only'>Close</span></button>
 6 |             <h4 class='modal-title' id='exampleModalLabel'>Search</h4>
 7 |           </div>
 8 |           <div class='modal-body'>
 9 |             <p>
10 |               From here you can search these documents. Enter
11 |               your search terms below.
12 |             </p>
13 |             <form role='form'>
14 |               <div class='form-group'>
15 |                 <input type='text' class='form-control' placeholder='Search...' id='mkdocs-search-query'>
16 |               </div>
17 |             </form>
18 |             <div id='mkdocs-search-results'></div>
19 |           </div>
20 |           <div class='modal-footer'>
21 |           </div>
22 |         </div>
23 |       </div>
24 |     </div>
25 | 
26 | 


--------------------------------------------------------------------------------
/theme/toc-sub.html:
--------------------------------------------------------------------------------
1 | <ul class='toc-subnav toc-expand'>
2 | {% for toc_item in toc %}
3 |   <li class='main{% if toc_item.active %} active{% endif %}'><a href='{{ toc_item.url }}'>{{ toc_item.title }}</a></li>
4 |   {% for toc_item in toc_item.children %}
5 |     <li><a href='{{ toc_item.url }}'>{{ toc_item.title }}</a></li>
6 |   {% endfor %}
7 | {% endfor %}
8 | </ul>
9 | 


--------------------------------------------------------------------------------
/theme/toc.html:
--------------------------------------------------------------------------------
 1 | <div class='toc hidden-print' role='directory' id='toc'>
 2 |   <ul class='nav toc-nav'>
 3 |   <!-- Elements of the nav come from each section's config file, toc contents come from parsed html -->
 4 |   <!-- Sub-nav is coming from config too, but sub-toc contents come from the html of the page -->
 5 |   {% if include_nav %}
 6 |     {% for nav_item in nav if not nav_item.title == 'README' %}
 7 |       {% if nav_item.children %}
 8 |         <li class='toc-top-level{% if nav_item.active %} toc-current{% endif %}'>
 9 |           <a href='#' class='toc-subnav-toggle'>{{ nav_item.title }}</a>
10 |           {% if not (loop.first and config.extra.exclude_home_contents_in_toc == true) %}
11 |             <ul class='toc-subnav{% if nav_item.active %} toc-expand{% endif %}'>
12 |               {% for nav_item in nav_item.children %}
13 |                 {% include 'nav-sub.html' %}
14 |               {% endfor %}
15 |             </ul>
16 |           {% endif %}
17 |         </li>
18 |       {% else %}
19 |         <li class='toc-top-level{% if nav_item.active %} toc-current{% endif %}'>
20 |           <a href='{{ nav_item.url }}'>{{ nav_item.title }}</a>
21 |         </li>
22 |         {% if not (loop.first and config.extra.exclude_home_contents_in_toc == true) %}
23 |           {% if nav_item.active %}
24 |             {% include 'toc-sub.html' %}
25 |           {% endif %}
26 |         {% endif %}
27 |       {% endif %}
28 |     {% endfor %}
29 |   {% endif %}
30 |   </ul>
31 | </div>


--------------------------------------------------------------------------------