README.md

mapbox.js

This is the Mapbox Javascript API, version 1.x. It's built as a Leaflet plugin. You can read about its launch.

API

Managed as Markdown in API.md, following the standards in DOCUMENTING.md

Examples

Usage with Browserify

Install the mapbox.js module and add it to dependencies in package.json:

npm install mapbox.js --save

Require mapbox in your script:

// main.js

require('mapbox.js'); // <-- auto-attaches to window.L

Browserify it:

browserify main.js -o bundle.js

Building

Requires node.js installed on your system.

git clone https://github.com/mapbox/mapbox.js.git
cd mapbox.js
npm install
make

This project uses browserify to combine dependencies and installs a local copy when you run npm install. make will build the project in dist/.

Tests

Test with phantomjs:

npm test

To test in a browser, run a local development server and go to /test.

Version v0.x.x

Version v0.x.x can be accessed in the v0 branch..

Editing Icons

Requirements:

inkscape
pngquant
convert (part of imagemagick)

1. Make edits to theme/images/icons.svg.
2. Run ./theme/images/render.sh to update sprites from your edits.
3. Add a CSS reference with the appropriate pixel coordinate if adding a new icon.