First, charites init command will create a charites project named as <project_dir> as follows.
Options
--tilejson-urls <tilejson_urls> an URL for TileJSON.
--metadatajson-urls <metadatajson_urls> an URL for metadata.json.
--composite-layers a single YAML will be generated with multiple layers.
--header add http header for the tile authenticated by origin. (ex. --header "Origin: http://localhost:8080")
project-directory/
├── style.yml - root style file
├── config.yml - configuration file to manage all folder paths and necessary settings for producing style.json
├── layers/ - style.yml for layers
├── icons/ - original SVG icons folder for sprite
├── fonts/ - original font files folder for glyphs.
└── public/ - folder for the files that ready to deploy.
├── style.json
├── icons.json
├── icons.png
├── icons@2x.json
├── icons@2x.png
└── glyphs files(.pbf?) - sorry I need research what type of file used for glyphs.
version: version of charites used
serve:
port: 8080
style:
build:
yaml-path: ./style.yml
json-path: ./public/style.json
compact-output: false
sprite:
build:
icons-folder: ./icons
sprite-folder: ./public/sprite
name: icons
glyphs:
build:
fonts-folder: ./fonts
glyphs-folder: ./public/glyphs
Initializing a project
First,
charites initcommand will create a charites project named as<project_dir>as follows.Options
--tilejson-urls <tilejson_urls>an URL for TileJSON.--metadatajson-urls <metadatajson_urls>an URL for metadata.json.--composite-layersa single YAML will be generated with multiple layers.--headeradd http header for the tile authenticated by origin. (ex.--header "Origin: http://localhost:8080")