An easy, intuitive, and efficient command-line tool for writing vector map styles compatible with the MapLibre Style Specification in YAML. With YAML format's readability, JSON compiler, linter, and live style viewer on a local browser, you can simplify your map styling workflow.

In Greek mythology, the Charites are the three goddesses of charm, beauty, and human creativity. They are believed to have been worshipped not only by artists but also by those who aspired to technology to infuse them with a creative spirit.

• Initiate a project from scratch, or convert an existing style.json file to generate YAML style files.
• Write styles in a simple YAML format.
• Divide groups of layers in to multiple files for better readability and mantainability. !!inc/file <relative-path-to-the-file>
• Use variables like $backgroundColor and $waterColor to style effectively.
• Compile YAML to a single style.json file, with a format linter.
• Run charites serve <source> to preview your style live while you make changes in a browser.

Documentation is available here.

see CONTRIBUTING.md

MIT

• Node.js v20 or later

Build the Docker image:

docker build -t charites:latest .

Run charites commands in Docker:

docker run --rm -v $(pwd):/data -u $(id -u):$(id -g) charites:latest init /data/my-style.yml
docker run --rm -v $(pwd):/data -u $(id -u):$(id -g) charites:latest convert /data/style.json /data/style.yml
docker run --rm -v $(pwd):/data -u $(id -u):$(id -g) charites:latest build /data/style.yml /data/style.json
docker run --init -it --rm -p 8080:8080 -v $(pwd):/data charites:latest serve /data/style.yml

Note: charites serve requires running as root user because it needs to rebuild vite server inside the container.

Thanks goes to these wonderful people (emoji key):

Geolonia 💻

Naoki Ohashi 💻

UBUKAWA Taro 💻

Takayuki Miyauchi 💻

Jin Igarashi 💻

Taro Matsuzawa aka. btm 💻

Shinichi Nishikawa 📖

yuiseki 💻

This project follows the all-contributors specification. Contributions of any kind welcome!