You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
16
16
17
17
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.
18
18
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.
20
20
21
21
## Documentation
22
22
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.
24
25
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
26
28
27
-
```
29
+
```bash
28
30
npm run mkdocs
29
31
```
30
32
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:
32
35
33
-
```
36
+
```bash
34
37
WATCH=1 npm run generate-docs
35
38
```
36
39
37
40
This will re-run the generation script when needed.
38
41
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.
40
44
41
45
## NPM Package
42
46
43
47
44
48
The MapLibre style specification and utilities are published as a separate npm
45
49
package so that they can be installed without the bulk of GL JS.
46
50
47
-
npm install @maplibre/maplibre-gl-style-spec
51
+
```bash
52
+
npm install @maplibre/maplibre-gl-style-spec
53
+
```
48
54
49
55
## CLI Tools
50
56
51
57
If you install this package globally, you will have access to several CLI tools.
0 commit comments