Have ideas to improve npm?Join in the discussion! »


    0.3.2 • Public • Published

    Reference Layer for TileMill

    This TileMill plugin adds a custom map as a reference layer to your TileMill projects.

    This reference layer will be visible while designing & previewing a map, but will not be included in any exports.


    The plugin should be available from the Plugins panel in TileMill.

    You can also install it manually by cloning this repository into your TileMill plugins directory.The plugins directory for TileMill is located at ~/.tilemill/node_modules. It will not exist if you have not already installed a plugin. So you may need to create it yourself. You can create the plugins directory and install this plugin manually like:

    mkdir -p ~/.tilemill/node_modules
    cd ~/.tilemill/node_modules
    git clone https://github.com/mapbox/tilemill-reference-layer.git

    Note: This plugin is not tested to work with other plugins.


    • Enable the plugin

    • Go to a projects settings, and enter a map ID from your Mapbox.com map, or a URL for a TileJSON Service, in the Reference Layer field.

    • You can get the map ID from the Project settings on Mapbox.com.

    • If you have a custom tileset available elsewhere, you'll need a TileJSON service to describe this map. You can use the URL of this service for the Reference Layer field.

    • Design a map with a transparent Map background

    • Upload your map to Mapbox

    • Add your map to a composite with your map

    • Share your map!



    npm i tilemill-reference-layer

    DownloadsWeekly Downloads






    Last publish


    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar