diff --git a/README.md b/README.md index f9c2e755..c002e2e6 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ # MapLibre Style Specification & Utilities -[![NPM Version](https://badge.fury.io/js/@maplibre%2Fmaplibre-gl-style-spec.svg)](https://npmjs.org/package/@maplibre/maplibre-gl-style-spec) +[![NPM Version](https://badge.fury.io/js/@maplibre%2Fmaplibre-gl-style-spec.svg)](https://npmjs.org/package/@maplibre/maplibre-gl-style-spec) [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg?style=flat)](LICENSE.txt) [![PRs](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](https://opensource.org/licenses/BSD-3-Clause) [![codecov](https://codecov.io/gh/maplibre/maplibre-style-spec/branch/main/graph/badge.svg)](https://codecov.io/gh/maplibre/maplibre-style-spec) This repository contains code and reference files that define the MapLibre style specification and provides some utilities for working with MapLibre styles. @@ -16,27 +16,31 @@ The style specification is used in MapLibre GL JS and in MapLibre Native. Our lo 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. +We aim to avoid breaking changes in the MapLibre style specification because it makes life easier for our users. ## Documentation -The [documentation](https://maplibre.org/maplibre-style-spec) of the style specification also lives in this repository. We use [MkDocs](https://www.mkdocs.org/) with the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material) theme. +The [documentation](https://maplibre.org/maplibre-style-spec) of the style specification also lives in this repository. +We use [MkDocs](https://www.mkdocs.org/) with the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material) theme. -To work on the documentation locally, you need to have Docker installed and running. Start MkDocs with +To work on the documentation locally, you need to have Docker installed and running. +Start MkDocs with -``` +```bash npm run mkdocs ``` -Most of the documentation is generated (from e.g. `v8.json`). In another terminal, run: +Most of the documentation is generated (from e.g. `v8.json`). +In another terminal, run: -``` +```bash 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. +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 @@ -44,18 +48,22 @@ Note that generated files should not be checked in and they are excluded in `.gi 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 +```bash +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 +```bash +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: +This repo contains scripts for migrating GL styles of any version to the latest version (currently v8). +You can migrate a style like this: ```bash $ gl-style-migrate bright-v7.json > bright-v8.json @@ -82,5 +90,5 @@ Will format the given style JSON to use standard indentation and sorted object k $ gl-style-validate style.json ``` -Will validate the given style JSON and print errors to stdout. Provide a -`--json` flag to get JSON output. +Will validate the given style JSON and print errors to stdout. +Provide a `--json` flag to get JSON output. \ No newline at end of file