Skip to content

Latest commit

 

History

History
81 lines (49 loc) · 3.02 KB

README.md

File metadata and controls

81 lines (49 loc) · 3.02 KB
Raw

MapLibre Style Specification & Utilities

NPM Version License PRs codecov

This repository contains code and reference files that define the MapLibre style specification and provides some utilities for working with MapLibre styles.

The style specification is used in MapLibre GL JS and in MapLibre Native. Our long-term goal is to have feature parity between the web and the native libraries.

Contributing

If you want to contribute to the style specification, please open an issue with a design proposal. Once your design proposal has been accepted, you can open a pull request and implement your changes.

We aim to avoid breaking changes in the MapLibre style specification, because it makes life easier for our users.

Documentation

The documentation of the style specification also lives in this repository. We use MkDocs with the Material for MkDocs theme.

To work on the documentation locally, you need to have Docker installed and running. Start MkDocs with

npm run mkdocs

Most of the documentation is generated (from e.g. v8.json). In another terminal, run:

WATCH=1 npm run generate-docs

This will re-run the generation script when needed.

Note that generated files should not be checked in and they are excluded in .gitignore. Make sure to keep this file up-to-date and ignore generated files while making sure static Markdown files are not ignored.

NPM Package

The MapLibre style specification and utilities are published as a separate npm package so that they can be installed without the bulk of GL JS.

npm install @maplibre/maplibre-gl-style-spec

CLI Tools

If you install this package globally, you will have access to several CLI tools.

npm install @maplibre/maplibre-gl-style-spec --global

gl-style-migrate

This repo contains scripts for migrating GL styles of any version to the latest version (currently v8). Migrate a style like this:

$ gl-style-migrate bright-v7.json > bright-v8.json

To migrate a file in place, you can use the sponge utility from the moreutils package:

$ brew install moreutils
$ gl-style-migrate bright.json | sponge bright.json

gl-style-format

$ gl-style-format style.json

Will format the given style JSON to use standard indentation and sorted object keys.

gl-style-validate

$ gl-style-validate style.json

Will validate the given style JSON and print errors to stdout. Provide a --json flag to get JSON output.