Skip to content

Commit

Permalink
fix: indentions
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelKreil committed Oct 30, 2024
1 parent 31148cd commit 8ed718c
Showing 1 changed file with 34 additions and 34 deletions.
68 changes: 34 additions & 34 deletions compendium/specification_frontend.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,70 +16,70 @@ Based on best practices, the VersaTiles Frontend Specification defines a recomme
[Contains all static resources such as libraries, fonts, sprites, styles, images, ...](#folder-assets)

- πŸ“‚ **`glyphs/`**
[Contains font glyphs used for map text rendering](#folder-assetsglyphs)
[Contains font glyphs used for map text rendering](#folder-assetsglyphs)

- πŸ“‚ **`{font_id}/`**
Each font face is stored in its own folder, named by its font ID.
- πŸ“‚ **`{font_id}/`**
Each font face is stored in its own folder, named by its font ID.

- πŸ“„ **`{start}-{end}.pbf`**
The glyphs for each font are divided into ranges of 256 characters (e.g. `0-255.pbf`), with each file representing a particular Unicode range.
- πŸ“„ **`{start}-{end}.pbf`**
The glyphs for each font are divided into ranges of 256 characters (e.g. `0-255.pbf`), with each file representing a particular Unicode range.

- πŸ“„ **`font_families.json`**
[Defines all available font families and their font faces (e.g. regular, italic, bold, condensed) along with their properties.](#file-assetsglyphsfont_familiesjson)
- πŸ“„ **`font_families.json`**
[Defines all available font families and their font faces (e.g. regular, italic, bold, condensed) along with their properties.](#file-assetsglyphsfont_familiesjson)

- πŸ“„ **`index.json`**
[A JSON file that lists all available font IDs, essentially providing an index of all the fonts in the `assets/glyphs/` folder.](#file-assetsglyphsindexjson)
- πŸ“„ **`index.json`**
[A JSON file that lists all available font IDs, essentially providing an index of all the fonts in the `assets/glyphs/` folder.](#file-assetsglyphsindexjson)

- πŸ“‚ **`lib/`**
Contains all JavaScript/CSS libraries.
Contains all JavaScript/CSS libraries.

- πŸ“‚ **`maplibre-gl/`**
Folder for [MapLibre GL JS](https://github.com/maplibre/maplibre-gl-js), which must contain both `maplibre-gl.js` and `maplibre-gl.css` files for map rendering.
- πŸ“‚ **`maplibre-gl/`**
Folder for [MapLibre GL JS](https://github.com/maplibre/maplibre-gl-js), which must contain both `maplibre-gl.js` and `maplibre-gl.css` files for map rendering.

- πŸ“‚ **`versatiles-style/`**
Folder for [VersaTiles Style](https://github.com/versatiles-org/versatiles-style), which contains the `versatiles-style.js` file to generate map styles.
- πŸ“‚ **`versatiles-style/`**
Folder for [VersaTiles Style](https://github.com/versatiles-org/versatiles-style), which contains the `versatiles-style.js` file to generate map styles.

- πŸ“‚ **`.../`**
Optionally you can include other libraries such as [MapLibre GL Inspect](https://github.com/maplibre/maplibre-gl-inspect), ...
- πŸ“‚ **`.../`**
Optionally you can include other libraries such as [MapLibre GL Inspect](https://github.com/maplibre/maplibre-gl-inspect), ...

- πŸ“‚ **`sprites/`**
[Contains all map sprites (image files with multiple small graphical icons or symbols used on the map)](#folder-assetssprites)
[Contains all map sprites (image files with multiple small graphical icons or symbols used on the map)](#folder-assetssprites)

- πŸ“‚ **`{sprite_id}/`**
- πŸ“‚ **`{sprite_id}/`**
Each sprite is stored in its own directory, named by its sprite ID.

- πŸ“„ **`sprite.json`**
The metadata for the sprite set, defined according to the [Sprite Source Format](https://maplibre.org/maplibre-style-spec/sprite/#sprite-source-format).
- πŸ“„ **`sprite.json`**
The metadata for the sprite set, defined according to the [Sprite Source Format](https://maplibre.org/maplibre-style-spec/sprite/#sprite-source-format).

- πŸ“„ **`sprite.png`**
The actual sprite image, containing all the sprite icons in a single PNG image file.
- πŸ“„ **`sprite.png`**
The actual sprite image, containing all the sprite icons in a single PNG image file.

- πŸ“„ **`index.json`**
[A JSON file listing all available sprite IDs.](#file-assetsspritesindexjson)
- πŸ“„ **`index.json`**
[A JSON file listing all available sprite IDs.](#file-assetsspritesindexjson)

- πŸ“‚ **`styles/`**
Contains prepared map styles.
Contains prepared map styles.

- πŸ“„ **`{style_id}/style.json`**
Each map style is stored in a separate folder. It must contain a `style.json` file following the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/) to define how the map is rendered. The folder may also contain additional files such as style-specific sprite definitions.
- πŸ“„ **`{style_id}/style.json`**
Each map style is stored in a separate folder. It must contain a `style.json` file following the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/) to define how the map is rendered. The folder may also contain additional files such as style-specific sprite definitions.

- πŸ“‚ **`.../`**
Optional subfolders such as `css/`, `fonts/`, `images/` and `js/` can be included as needed for additional resources.
Optional subfolders such as `css/`, `fonts/`, `images/` and `js/` can be included as needed for additional resources.

- πŸ“‚ **`tiles/`**
[The contents of this folder are generated and returned by the tile server.](#folder-tiles)

- πŸ“‚ **`{tileset_id}/`**
Each tile set is organised in its own folder.
Each tile set is organised in its own folder.

- πŸ“„ **`{z}/{x}/{y}{.ext}`**
[The individual map tiles are stored in subdirectories based on zoom level (`{z}`), column (`{x}`) and row (`{y}`). The tile file extension (`{.ext}`) is optional.](#files-tilestileset_idzxyext)
- πŸ“„ **`{z}/{x}/{y}{.ext}`**
[The individual map tiles are stored in subdirectories based on zoom level (`{z}`), column (`{x}`) and row (`{y}`). The tile file extension (`{.ext}`) is optional.](#files-tilestileset_idzxyext)

- πŸ“„ **`tiles.json`**
Metadata for each tile set following the [TileJSON specification](https://github.com/mapbox/tilejson-spec).
- πŸ“„ **`tiles.json`**
Metadata for each tile set following the [TileJSON specification](https://github.com/mapbox/tilejson-spec).

- πŸ“„ **`index.json`**
[JSON containing an array of all `tileset_id`s. This file acts as a directory of available tile sets.](#file-tilesindexjson)
[JSON containing an array of all `tileset_id`s. This file acts as a directory of available tile sets.](#file-tilesindexjson)


## Folder: `/assets/`
Expand Down

0 comments on commit 8ed718c

Please sign in to comment.