Skip to content
Documentation for the various Mapbox SDKs and libraries for Android
HTML Other
  1. HTML 99.4%
  2. Other 0.6%
Branch: publisher-prod…
Clone or download
Latest commit d02fe7b Oct 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github [tests] make link-checker throw warnings; add PR template (#931) Apr 18, 2019
api Nav SDK 0.42.1 bump & API ref docs (#1126) Oct 18, 2019
bin Batfishify (#157) Aug 9, 2017
conf Adding page about Scale Bar Plugin (#985) Jun 24, 2019
examples bumped examples submodule for to match demo app Oct 8, 2019
plugins Add localization doc to https://www.mapbox.com/android-docs/navigation ( Dec 14, 2018
scripts Only generate javadoc for stable versions (#1117) Oct 15, 2019
source-code [maps] Updates for android-v8.4.0 (#1101) Sep 26, 2019
src Nav SDK 0.42.1 bump & API ref docs (#1126) Oct 18, 2019
vendor/docs-page-shell Update page shell Sep 18, 2019
.artifacts.yml Port to Publisher V2 (#694) Oct 29, 2018
.copyeditorrc [tests] add copyeditor (#873) Mar 11, 2019
.eslintignore Automatically update maps API docs when a new release happens (#1072) Sep 24, 2019
.eslintrc Batfishify (#157) Aug 9, 2017
.gitignore [docs] remove config.yml (#840) Feb 7, 2019
.gitmodules Automatically update maps API docs when a new release happens (#1072) Sep 24, 2019
.nvmrc Updated examples submodule to refresh examples (#1022) Aug 12, 2019
.prettierignore Navigation SDK narrative docs reorganization (#842) Feb 27, 2019
.publisher.yml First shot at new-domain staging Jan 15, 2019
.remarkrc [tests] make link-checker throw warnings; add PR template (#931) Apr 18, 2019
.travis.yml [ci] address version parsing issues and update android SDK for latest… Sep 28, 2019
CONTRIBUTING.md [ci] address version parsing issues and update android SDK for latest… Sep 28, 2019
README.md Adding README blurb about Java/Kotlin toggles (#915) Apr 29, 2019
android.dic Refactoring code snippets to use onStyleLoaded callback (#1071) Sep 5, 2019
batfish.config.js Update to dr-ui 0.21.2 (#1078) Sep 19, 2019
package-lock.json Automatically update maps API docs when a new release happens (#1072) Sep 24, 2019
package.json Automatically update maps API docs when a new release happens (#1072) Sep 24, 2019
plugin-image.html Updated plugin pages (#339) Mar 7, 2018

README.md

Android documentation

Build Status

This repo hosts all of the Android documentation for the Mapbox platform, including the Maps SDK, the Java SDK, the Navigation SDK, and Mapbox Plugins. Visit Mapbox Android Docs to view the live website.

Getting started

Requirements

To host this website locally, you'll need to have Node.js installed and setup via nvm.

Installation

This repository uses git submodules, so it needs to be cloned recursively to include:

git clone --recursive git@github.com:mapbox/android-docs.git

Change your working directory to the cloned repository:

cd android-docs

Use nvm to install and use the version of node specified in .nvmrc:

nvm install
nvm use

Upgrade your version of npm:

npm install -g npm@6

To install site and build dependencies, run:

npm install

Hosting locally

The Android documentation uses Batfish, a static-site generator powered by react and webpack. To get started contributing to the documentation and running the site locally you'll need to navigate to this projects folder and execute:

npm start

This will set up a server running at http://localhost:8080/android/. If you make changes to the source content, your browser should automatically refresh using livereload once you save the file.

Running tests locally

To run the tests locally, run:

npm test

The test suite will lint JavaScript as well as:

If the tests return an error or warning, follow the guidance from the test to fix it.

Updating for SDK releases

To update the site for a Maps SDK or Navigation SDK release:

  1. Run node scripts/update.js <product> <version>. Where :
    • <product> is either maps or navigation
    • <version> is the version number. It must follow the format X.X.X, where X is an integer. Optional: append the version number with -beta.X or -rc.X where X is also an integer.
  2. Commit and push the commits that are created.

Running scripts/update.js will:

Contributing new documentation

If you'd like to add to this repo's Android documentation, please read the contribution guide to learn how to get started.

You can’t perform that action at this time.