@trailstash/ultra 3.4.3 → 3.4.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/docs/index.md +41 -31
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
Ultra (née Overpass Ultra) is a web-application made to simplify making maps with [MapLibre GL
|
|
4
4
|
JS](https://maplibre.org).
|
|
5
5
|
|
|
6
|
-
- Stable version - [overpass-ultra.us](https://overpass-ultra.us) <small>([config](https://gitlab.com/trailstash/overpass-ultra/-/blob/main/config.
|
|
7
|
-
- Latest version - [ultra.trailsta.sh](https://ultra.trailsta.sh) <small>([config](https://gitlab.com/trailstash/ultra/-/blob/main/config.
|
|
6
|
+
- Stable version - [overpass-ultra.us](https://overpass-ultra.us) <small>([config](https://gitlab.com/trailstash/overpass-ultra/-/blob/main/config.mjs))</small>
|
|
7
|
+
- Latest version - [ultra.trailsta.sh](https://ultra.trailsta.sh) <small>([config](https://gitlab.com/trailstash/ultra/-/blob/main/config.mjs))</small>
|
|
8
8
|
- OHM version - [ohm.overpass-ultra.us](https://ohm.overpass-ultra.us) <small>([config](https://gitlab.com/trailstash/ohm-ultra/-/blob/main/config.js))</small>
|
|
9
9
|
|
|
10
10
|
## Documentation
|
package/docs/index.md
CHANGED
|
@@ -16,45 +16,55 @@ It can easily visualize the following file/query types:
|
|
|
16
16
|
* [OSM XML](https://wiki.openstreetmap.org/wiki/OSM_XML)
|
|
17
17
|
* [OSM JSON](https://wiki.openstreetmap.org/wiki/OSM_JSON)
|
|
18
18
|
|
|
19
|
+
## Getting Started
|
|
20
|
+
All Ultra maps defined by a document containing an optional configuration and optional query. For
|
|
21
|
+
example, to query bicycle repair stations using the [Overpass API](https://overpass-api.de), you
|
|
22
|
+
can make a document containing an OverpassQL query:
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
node[amenity=bicycle_repair_station]({{bbox}});
|
|
26
|
+
out;
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Or to place a red marker at Eiffel Tower using a GeoJSON document as the query:
|
|
30
|
+
```
|
|
31
|
+
---
|
|
32
|
+
style:
|
|
33
|
+
layers:
|
|
34
|
+
- type: symbol
|
|
35
|
+
icon-image: maki:marker
|
|
36
|
+
icon-color: red
|
|
37
|
+
icon-anchor: bottom
|
|
38
|
+
---
|
|
39
|
+
{
|
|
40
|
+
"type": "FeatureCollection",
|
|
41
|
+
"features": [
|
|
42
|
+
{
|
|
43
|
+
"type": "Feature",
|
|
44
|
+
"properties": {},
|
|
45
|
+
"geometry": {
|
|
46
|
+
"coordinates": [
|
|
47
|
+
2.2945119627238455,
|
|
48
|
+
48.85826635779679
|
|
49
|
+
],
|
|
50
|
+
"type": "Point"
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
]
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
For more examples, see the [Examples](./Examples) and [MapLibre Examples](./MapLibre Examples)
|
|
58
|
+
sections.
|
|
59
|
+
|
|
19
60
|
## Configuration
|
|
20
61
|
|
|
21
62
|
Various aspects of Ultra, such as styling, can be
|
|
22
63
|
configured via [YAML front-matter](./yaml.md).
|
|
23
64
|
|
|
24
|
-
## Query Bounds
|
|
25
|
-
|
|
26
|
-
The following shortcuts are available to parameterize your queries:
|
|
27
|
-
|
|
28
|
-
| shortcut | description |
|
|
29
|
-
| -------- | ----------- |
|
|
30
|
-
| `{{bbox}}` | The map's bounds in the format expected by [Overpass](https://overpass-api.de) |
|
|
31
|
-
| `{{south}}` | The Southern Latitude of the map's bounds |
|
|
32
|
-
| `{{north}}` | The Northern Latitude of the map's bounds |
|
|
33
|
-
| `{{east}}` | The Eastern Longitude of the map's bounds |
|
|
34
|
-
| `{{west}}` | The Western Longitude of the map's bounds |
|
|
35
|
-
|
|
36
65
|
## Styling
|
|
37
66
|
|
|
38
67
|
Ultra supports styling using an extended version of the the
|
|
39
68
|
[MapLibre Style Spec](https://maplibre.org/maplibre-style-spec/).
|
|
40
69
|
|
|
41
70
|
See the [Styling](./style.md) section for more information.
|
|
42
|
-
|
|
43
|
-
## About
|
|
44
|
-
|
|
45
|
-
Ultra is built by Daniel Schep.
|
|
46
|
-
|
|
47
|
-
You can contact me on [Mastodon](https://mapstodon.space/@trailstash).
|
|
48
|
-
|
|
49
|
-
## Feedback, Bug Reports, Feature Requests
|
|
50
|
-
|
|
51
|
-
While Ultra has been in development for a while, it should still be considered
|
|
52
|
-
experimental.
|
|
53
|
-
|
|
54
|
-
If you would like to report a bug or provide other feedback, please do so in the project's
|
|
55
|
-
[Issue Tracker](https://gitlab.com/trailstash/ultra/-/issues).
|
|
56
|
-
|
|
57
|
-
## Source Code</h4>
|
|
58
|
-
|
|
59
|
-
The [source code](https://gitlab.com/trailstash/ultra) of this application is released under the
|
|
60
|
-
[MIT license](https://gitlab.com/trailstash/ultra/-/blob/master/LICENSE).
|
package/package.json
CHANGED