Charites - Documentation

Date:

2022-12-15

Copyright:

CC-BY-SA

Organization:

The United Nations Vector Tile Toolkit

Version:

0.3.0

Abstract:

This document contains the complete documentation of Charites, an application to style vector tiles easily

An easy, intuitive, and efficient command-line tool for writing vector map styles compatible with the Mapbox and 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.

Note

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.

Features

  • 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.

  • Use –provider mapbox to validate your style against Mapbox GL JS v2.x

  • Run charites serve <source> to preview your style live while you make changes in a browser.

Translations

The documentation is available in several languages.

If there is an error with a translation, please help to improve it.

Indices and tables