Skip to content

Commit b9cdca5

Browse files
reformat parts of the readme
1 parent 7fcea88 commit b9cdca5

File tree

1 file changed

+22
-14
lines changed

1 file changed

+22
-14
lines changed

README.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
# MapLibre Style Specification & Utilities
77

8-
[![NPM Version](https://badge.fury.io/js/@maplibre%2Fmaplibre-gl-style-spec.svg)](https://npmjs.org/package/@maplibre/maplibre-gl-style-spec)
8+
[![NPM Version](https://badge.fury.io/js/@maplibre%2Fmaplibre-gl-style-spec.svg)](https://npmjs.org/package/@maplibre/maplibre-gl-style-spec)
99
[![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)
1010

1111
This repository contains code and reference files that define the MapLibre style specification and provides some utilities for working with MapLibre styles.
@@ -16,46 +16,54 @@ The style specification is used in MapLibre GL JS and in MapLibre Native. Our lo
1616

1717
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.
1818

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

2121
## Documentation
2222

23-
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.
23+
The [documentation](https://maplibre.org/maplibre-style-spec) of the style specification also lives in this repository.
24+
We use [MkDocs](https://www.mkdocs.org/) with the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material) theme.
2425

25-
To work on the documentation locally, you need to have Docker installed and running. Start MkDocs with
26+
To work on the documentation locally, you need to have Docker installed and running.
27+
Start MkDocs with
2628

27-
```
29+
```bash
2830
npm run mkdocs
2931
```
3032

31-
Most of the documentation is generated (from e.g. `v8.json`). In another terminal, run:
33+
Most of the documentation is generated (from e.g. `v8.json`).
34+
In another terminal, run:
3235

33-
```
36+
```bash
3437
WATCH=1 npm run generate-docs
3538
```
3639

3740
This will re-run the generation script when needed.
3841

39-
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.
42+
Note that generated files should not be checked in, and they are excluded in `.gitignore`.
43+
Make sure to keep this file up to date and ignore generated files while making sure static Markdown files are not ignored.
4044

4145
## NPM Package
4246

4347

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

47-
npm install @maplibre/maplibre-gl-style-spec
51+
```bash
52+
npm install @maplibre/maplibre-gl-style-spec
53+
```
4854

4955
## CLI Tools
5056

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

53-
npm install @maplibre/maplibre-gl-style-spec --global
59+
```bash
60+
npm install @maplibre/maplibre-gl-style-spec --global
61+
```
5462

5563
### `gl-style-migrate`
5664

57-
This repo contains scripts for migrating GL styles of any version to the latest version
58-
(currently v8). Migrate a style like this:
65+
This repo contains scripts for migrating GL styles of any version to the latest version (currently v8).
66+
You can migrate a style like this:
5967

6068
```bash
6169
$ 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
8290
$ gl-style-validate style.json
8391
```
8492

85-
Will validate the given style JSON and print errors to stdout. Provide a
86-
`--json` flag to get JSON output.
93+
Will validate the given style JSON and print errors to stdout.
94+
Provide a `--json` flag to get JSON output.

0 commit comments

Comments
 (0)