ashatora/editor
1
0
Fork 0
mirror of https://github.com/maputnik/editor.git synced 2026-08-27 15:37:27 +00:00
Code Issues Projects Releases Wiki Activity

Add docs

Browse Source
This commit is contained in:
pathmapper
2020-07-23 20:19:33 +02:00
parent 77ed14a340
commit 4661677387
1 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+11 -4
View File
@@ -18,14 +18,14 @@ You can download a single binary for Linux, OSX or Windows from [the latest rele
Simply start up a web server and access the Maputnik editor GUI at `localhost:8000`. Simply start up a web server and access the Maputnik editor GUI at `localhost:8000`.
``` ```bash
maputnik maputnik
``` ```
Expose a local style file to Maputnik allowing the web based editor Expose a local style file to Maputnik allowing the web based editor
to save to the local filesystem. to save to the local filesystem.
``` ```bash
maputnik --file basic-v9.json maputnik --file basic-v9.json
``` ```
@@ -33,16 +33,23 @@ Watch the local style for changes and inform the editor via web socket.
This makes it possible to edit the style with a local text editor and still This makes it possible to edit the style with a local text editor and still
use Maputnik. use Maputnik.
``` ```bash
maputnik --watch --file basic-v9.json maputnik --watch --file basic-v9.json
``` ```
Choose a local port to listen on, instead of using the default port 8000. Choose a local port to listen on, instead of using the default port 8000.
``` ```bash
maputnik --port 8001 maputnik --port 8001
``` ```
Specify a path to a directory which, if it exists, will be served under http://localhost:8000/static/ .
Could be used to serve sprites and glyphs.
```bash
maputnik --static ./localFolder
```
### API ### API
`maputnik` exposes the configured styles via a HTTP API. `maputnik` exposes the configured styles via a HTTP API.