From 3df0686ae7f020f74ea5638504e1f1d8ff1e0484 Mon Sep 17 00:00:00 2001 From: Tawera Manaena Date: Wed, 6 Nov 2024 12:05:57 +1300 Subject: [PATCH 1/7] docs: add watch mode tip --- docs/developer-guide/run-basemaps-locally.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/developer-guide/run-basemaps-locally.md b/docs/developer-guide/run-basemaps-locally.md index 3d3a3cbea..365ec0616 100644 --- a/docs/developer-guide/run-basemaps-locally.md +++ b/docs/developer-guide/run-basemaps-locally.md @@ -56,7 +56,7 @@ Clone the [**linz/basemaps**][bm_repo] repository to your machine. !!! abstract "Path" This guide uses variables as shorthand to reference key directories and files. On your machine, consider the following path: - + === "`BM_REPO`" The path to the **basemaps** repository folder on your machine. @@ -80,6 +80,15 @@ npm run build npm run test ``` +!!! tip + + You can build the `basemaps` packages in [watch mode][tsc_watch] so that they recompile anytime you modify the source code. In a terminal, navigate to `BM_REPO` and run the following command: + + ```bash + # Generate the /build for each package (watch mode) + npm run build -- --watch + ``` + ## Configure the `basemaps/server` package There are two main ways you can configure and run the **basemaps/server** package: @@ -102,4 +111,5 @@ There are two main ways you can configure and run the **basemaps/server** packag [bm_repo]: https://github.com/linz/basemaps [configuration]: https://github.com/linz/basemaps/blob/master/docs/configuration.md [contributing]: https://github.com/linz/basemaps/blob/master/CONTRIBUTING.md -[stac]: https://github.com/radiantearth/stac-spec/blob/master/overview.md \ No newline at end of file +[stac]: https://github.com/radiantearth/stac-spec/blob/master/overview.md +[tsc_watch]: https://www.typescriptlang.org/docs/handbook/project-references.html#tsc--b-commandline From 7f7c9a676b0c0f41a449f8ebe13f65499425c459 Mon Sep 17 00:00:00 2001 From: Tawera Manaena Date: Wed, 6 Nov 2024 13:07:55 +1300 Subject: [PATCH 2/7] docs: remove unused internal links --- .../cli-methods/bundle-the-basemaps-config-file.md | 6 ------ .../serve-basemaps-with-bundled-config-file.md | 2 -- .../serve-basemaps-with-collection-of-geotiff-files.md | 5 ----- 3 files changed, 13 deletions(-) diff --git a/docs/developer-guide/cli-methods/bundle-the-basemaps-config-file.md b/docs/developer-guide/cli-methods/bundle-the-basemaps-config-file.md index 1c397f8f0..7ee7ca2af 100644 --- a/docs/developer-guide/cli-methods/bundle-the-basemaps-config-file.md +++ b/docs/developer-guide/cli-methods/bundle-the-basemaps-config-file.md @@ -81,12 +81,6 @@ node $BM_CLI_BIN/bmc.js bundle \ Specifies the location of the cache directory. This parameter is optional but recommended to reduce the time needed to construct the config file. - - -[running-basemaps-locally]: ../running-basemaps-locally.md -[configuring-the-basemapsserver-package]: ../running-basemaps-locally.md#2-configuring-the-basemapsserver-package -[path-to-json-config-file]: ../Server%20Methods/json-config-file.md - [bm_config_repo]: https://github.com/linz/basemaps-config \ No newline at end of file diff --git a/docs/developer-guide/server-methods/serve-basemaps-with-bundled-config-file.md b/docs/developer-guide/server-methods/serve-basemaps-with-bundled-config-file.md index 901816e69..de2d18061 100644 --- a/docs/developer-guide/server-methods/serve-basemaps-with-bundled-config-file.md +++ b/docs/developer-guide/server-methods/serve-basemaps-with-bundled-config-file.md @@ -70,6 +70,4 @@ node $BM_SERVER_BIN/basemaps-server.cjs --config $CONFIG_FILE -[running-basemaps-locally]: ../running-basemaps-locally.md -[configuring-the-basemapsserver-package]: ../running-basemaps-locally.md#2-configuring-the-basemapsserver-package [bundle-the-basemaps-config-file]: ../cli-methods/bundle-the-basemaps-config-file.md \ No newline at end of file diff --git a/docs/developer-guide/server-methods/serve-basemaps-with-collection-of-geotiff-files.md b/docs/developer-guide/server-methods/serve-basemaps-with-collection-of-geotiff-files.md index 521995c28..6f1a36019 100644 --- a/docs/developer-guide/server-methods/serve-basemaps-with-collection-of-geotiff-files.md +++ b/docs/developer-guide/server-methods/serve-basemaps-with-collection-of-geotiff-files.md @@ -39,8 +39,3 @@ Use the following command to run the **Basemaps** system: ```bash node $BM_SERVER_BIN/basemaps-server.cjs $IMAGERY_DIR ``` - - - -[running-basemaps-locally]: ../running-basemaps-locally.md -[configuring-the-basemapsserver-package]: ../running-basemaps-locally.md#2-configuring-the-basemapsserver-package \ No newline at end of file From ec967f0ff4c8138cab23e667d9848070bfba9ce4 Mon Sep 17 00:00:00 2001 From: Tawera Manaena Date: Wed, 6 Nov 2024 13:16:16 +1300 Subject: [PATCH 3/7] docs: reference build dirs instead of bin dirs --- .../cli-methods/bundle-the-basemaps-config-file.md | 8 ++++---- .../serve-basemaps-with-bundled-config-file.md | 10 +++++----- .../serve-basemaps-with-collection-of-geotiff-files.md | 10 +++++----- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/developer-guide/cli-methods/bundle-the-basemaps-config-file.md b/docs/developer-guide/cli-methods/bundle-the-basemaps-config-file.md index 7ee7ca2af..8f97012da 100644 --- a/docs/developer-guide/cli-methods/bundle-the-basemaps-config-file.md +++ b/docs/developer-guide/cli-methods/bundle-the-basemaps-config-file.md @@ -44,14 +44,14 @@ Clone the [**linz/basemaps-config**][bm_config_repo] repository to your machine. $BM_CONFIG_REPO = {path_to}/basemaps-config ``` - === "`BM_CLI_BIN`" + === "`BM_CLI_BUILD`" The **basemaps/cli** package provides a **bundle** function we can use to generate a bundled config file. - The path to the **bin** folder of the **basemaps/cli** package. + The path to the **build** folder of the **basemaps/cli** package. ```bash - $BM_CLI_BIN = $BM_REPO/packages/cli/bin + $BM_CLI_BUILD = $BM_REPO/packages/cli/build/cli ``` ## Run the `basemaps/cli` package @@ -61,7 +61,7 @@ Clone the [**linz/basemaps-config**][bm_config_repo] repository to your machine. Use the following command to bundle the `basemaps` config file: ```bash -node $BM_CLI_BIN/bmc.js bundle \ +node $BM_CLI_BUILD/bin.js bundle \ --config $BM_CONFIG_REPO/config \ --output $BM_REPO/config/config.bundle.json \ --cache s3://linz-basemaps-staging/basemaps-config/cache/ diff --git a/docs/developer-guide/server-methods/serve-basemaps-with-bundled-config-file.md b/docs/developer-guide/server-methods/serve-basemaps-with-bundled-config-file.md index de2d18061..c56c8c0bb 100644 --- a/docs/developer-guide/server-methods/serve-basemaps-with-bundled-config-file.md +++ b/docs/developer-guide/server-methods/serve-basemaps-with-bundled-config-file.md @@ -46,12 +46,12 @@ At this stage, you should have a path to a config file. Either, to that which yo The **basemaps/server** package provides a default function to serve the **basemaps** system. Take note of the following path: - === "`BM_SERVER_BIN`" + === "`BM_SERVER_BUILD`" + + The path to the **build** folder of the **basemaps/server** package. - The path to the **bin** folder of the **basemaps/server** package. - ```bash - $BM_SERVER_BIN = $BM_REPO/packages/server/bin + $BM_SERVER_BUILD = $BM_REPO/packages/server/build ``` ### Command @@ -59,7 +59,7 @@ At this stage, you should have a path to a config file. Either, to that which yo Use the following command to run the **basemaps** system: ```bash -node $BM_SERVER_BIN/basemaps-server.cjs --config $CONFIG_FILE + node $BM_SERVER_BUILD/bin.js --config $CONFIG_FILE ``` ### Parameters diff --git a/docs/developer-guide/server-methods/serve-basemaps-with-collection-of-geotiff-files.md b/docs/developer-guide/server-methods/serve-basemaps-with-collection-of-geotiff-files.md index 6f1a36019..dd51da62a 100644 --- a/docs/developer-guide/server-methods/serve-basemaps-with-collection-of-geotiff-files.md +++ b/docs/developer-guide/server-methods/serve-basemaps-with-collection-of-geotiff-files.md @@ -24,12 +24,12 @@ The **basemaps/server** package requires a collection of GeoTIFF files from whic The **basemaps/server** package provides a default function to serve the **basemaps** system. Note the following path: - === "`BM_SERVER_BIN`" + === "`BM_SERVER_BUILD`" + + The path to the **build** folder of the **basemaps/server** package. - The path to the **bin** folder of the **basemaps/server** package. - ```bash - $BM_SERVER_BIN = $BM_REPO/packages/server/bin + $BM_SERVER_BUILD = $BM_REPO/packages/server/build ``` ### Command @@ -37,5 +37,5 @@ The **basemaps/server** package requires a collection of GeoTIFF files from whic Use the following command to run the **Basemaps** system: ```bash -node $BM_SERVER_BIN/basemaps-server.cjs $IMAGERY_DIR +node $BM_SERVER_BUILD/bin.js $IMAGERY_DIR ``` From b30435d876e67b76625a94c3e9c64896a07602b9 Mon Sep 17 00:00:00 2001 From: Tawera Manaena Date: Wed, 6 Nov 2024 13:17:45 +1300 Subject: [PATCH 4/7] docs: fix --output parameter description and usage --- .../cli-methods/bundle-the-basemaps-config-file.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/developer-guide/cli-methods/bundle-the-basemaps-config-file.md b/docs/developer-guide/cli-methods/bundle-the-basemaps-config-file.md index 8f97012da..8c7998d2b 100644 --- a/docs/developer-guide/cli-methods/bundle-the-basemaps-config-file.md +++ b/docs/developer-guide/cli-methods/bundle-the-basemaps-config-file.md @@ -63,7 +63,7 @@ Use the following command to bundle the `basemaps` config file: ```bash node $BM_CLI_BUILD/bin.js bundle \ --config $BM_CONFIG_REPO/config \ - --output $BM_REPO/config/config.bundle.json \ + --output config.bundle.json \ --cache s3://linz-basemaps-staging/basemaps-config/cache/ ``` @@ -75,7 +75,7 @@ node $BM_CLI_BUILD/bin.js bundle \ === "`--output`" - Specifies where to save the bundled config file. You can specify a location of your choice. This guide specifies the `basemaps` repository for convenience. + Specifies where to save the bundled config file, relative to the location from which you execute the command. You can specify a location and filename of your choice. === "`--cache`" From 1e769da382baa504e94135921cbbb16cb9a5f4d9 Mon Sep 17 00:00:00 2001 From: Tawera Manaena Date: Wed, 6 Nov 2024 13:19:18 +1300 Subject: [PATCH 5/7] docs: fix minor formatting inconsistencies --- .../cli-methods/bundle-the-basemaps-config-file.md | 6 +++--- .../serve-basemaps-with-collection-of-geotiff-files.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/developer-guide/cli-methods/bundle-the-basemaps-config-file.md b/docs/developer-guide/cli-methods/bundle-the-basemaps-config-file.md index 8c7998d2b..80888839d 100644 --- a/docs/developer-guide/cli-methods/bundle-the-basemaps-config-file.md +++ b/docs/developer-guide/cli-methods/bundle-the-basemaps-config-file.md @@ -32,10 +32,10 @@ Clone the [**linz/basemaps-config**][bm_config_repo] repository to your machine. gh repo clone linz/basemaps-config ``` -!!! abstract "Path" +!!! abstract "Paths" This guide uses variables as shorthand to reference key directories and files. On your machine, note the following paths: - + === "`BM_CONFIG_REPO`" The path to the **basemaps-config** repository folder on your machine. @@ -83,4 +83,4 @@ node $BM_CLI_BUILD/bin.js bundle \ -[bm_config_repo]: https://github.com/linz/basemaps-config \ No newline at end of file +[bm_config_repo]: https://github.com/linz/basemaps-config diff --git a/docs/developer-guide/server-methods/serve-basemaps-with-collection-of-geotiff-files.md b/docs/developer-guide/server-methods/serve-basemaps-with-collection-of-geotiff-files.md index dd51da62a..64c410493 100644 --- a/docs/developer-guide/server-methods/serve-basemaps-with-collection-of-geotiff-files.md +++ b/docs/developer-guide/server-methods/serve-basemaps-with-collection-of-geotiff-files.md @@ -13,7 +13,7 @@ The **basemaps/server** package requires a collection of GeoTIFF files from whic === "`IMAGERY_DIR`" The path to the root folder of your GeoTIFF file collection. - + ```bash $IMAGERY_DIR = {path_to_imagery_directory} ``` From c118d83cd1a299b0916872d96db7b3b75722d4fe Mon Sep 17 00:00:00 2001 From: Tawera Manaena Date: Wed, 6 Nov 2024 13:24:55 +1300 Subject: [PATCH 6/7] docs: add --assets usage documentation (wip) --- .../bundle-the-basemaps-assets-archive.md | 82 ++++++++++++++ ...serve-basemaps-with-bundled-config-file.md | 103 +++++++++++++----- 2 files changed, 159 insertions(+), 26 deletions(-) create mode 100644 docs/developer-guide/cli-methods/bundle-the-basemaps-assets-archive.md diff --git a/docs/developer-guide/cli-methods/bundle-the-basemaps-assets-archive.md b/docs/developer-guide/cli-methods/bundle-the-basemaps-assets-archive.md new file mode 100644 index 000000000..85e04b0be --- /dev/null +++ b/docs/developer-guide/cli-methods/bundle-the-basemaps-assets-archive.md @@ -0,0 +1,82 @@ +# Bundle the `basemaps` assets archive + +This guide explains how to generate the `basemaps` bundled assets archive using the **basemaps/cli** package. + +## Get started + +Clone the [**linz/basemaps-config**][bm_config_repo] repository to your machine. + +=== "HTTPS" + + ```bash + git clone https://github.com/linz/basemaps-config.git + ``` + +=== "SSH" + + ```bash + git clone git@github.com:linz/basemaps-config.git + ``` + +=== "GitHub CLI" + + ```bash + gh repo clone linz/basemaps-config + ``` + +!!! abstract "Paths" + + This guide uses variables as shorthand to reference key directories and files. On your machine, note the following paths: + + === "`BM_CONFIG_REPO`" + + The path to the **basemaps-config** repository folder on your machine. + + ```bash + $BM_CONFIG_REPO = {path_to}/basemaps-config + ``` + + === "`BM_CLI_BUILD`" + + The **basemaps/cli** package provides a **bundle-assets** function we can use to generate a bundled assets archive. + + The path to the **build** folder of the **basemaps/cli** package. + + ```bash + $BM_CLI_BUILD = $BM_REPO/packages/cli/build/cli + ``` + + === "`BM_SPRITES_BIN`" + + The **basemaps/sprites** package provides a default function we can use to generate sprite sheets from a collection of sprite images. + + The path to the **bin** folder of the **basemaps/sprites** package. + + ```bash + $BM_SPRITES_BIN = $BM_REPO/packages/sprites/bin + ``` +## Run the `basemaps/cli` package + +### Command + +Use the following command to bundle the `basemaps` assets archive: + +```bash +node $BM_CLI_BUILD/bin.js bundle-assets \ + --assets $BM_CONFIG_REPO/assets \ + --output assets.bundle.tar.co \ +``` + +### Parameters + +=== "`--assets`" + + Specifies the location of the assets folder to use. This folder refers to that of which is within the `basemaps-config` repository. + +=== "`--output`" + + Specifies where to save the bundled assets archive, relative to the location from which you execute the command. You can specify a location and filename of your choice. + + + +[bm_config_repo]: https://github.com/linz/basemaps-config diff --git a/docs/developer-guide/server-methods/serve-basemaps-with-bundled-config-file.md b/docs/developer-guide/server-methods/serve-basemaps-with-bundled-config-file.md index c56c8c0bb..234c144e4 100644 --- a/docs/developer-guide/server-methods/serve-basemaps-with-bundled-config-file.md +++ b/docs/developer-guide/server-methods/serve-basemaps-with-bundled-config-file.md @@ -4,43 +4,81 @@ This guide shows you how to configure and run the **basemaps/server** package us ## Configure the `basemaps/server` package -The **basemaps/server** package requires a config file to serve the **basemaps** system. +=== "Config file" -You have two options. The first is to use the pre-generated config file stored in the **LINZ AWS S3** bucket. The second is to generate the config file yourself using the **basemaps/cli** package. + The **basemaps/server** package requires a config file to serve the **basemaps** system. -=== "Using the pre-generated config file" + === "Using the pre-generated config file" - !!! abstract "Path" + !!! abstract "Path" - To use the exisiting config file stored in the **LINZ AWS S3** bucket, note of the following path: + To use the exisiting config file stored in the **LINZ AWS S3** bucket, note the following path: - === "`CONFIG_FILE`" + === "`CONFIG_FILE`" - The absolute path to the latest config file stored in the **LINZ AWS S3** bucket. - - ```bash - $CONFIG_FILE = s3://linz-basemaps/config/config-latest.json.gz - ``` + The absolute path to the latest config file stored in the **LINZ AWS S3** bucket. -=== "Generating the config file yourself" + ```bash + $CONFIG_FILE = s3://linz-basemaps/config/config-latest.json.gz + ``` - To generate the config file yourself, follow the [**Bundle the `basemaps` config file**][bundle-the-basemaps-config-file] guide. Then, return to this section. + === "Generating the config file yourself" - !!! abstract "Path" + To generate the config file yourself, follow the [**Bundle the `basemaps` config file**][bundle-the-basemaps-config-file] guide. Then, return to this section. - Once you have generated the config file, make a note of the file's location: + !!! abstract "Path" - === "`CONFIG_FILE`" + Once you have generated the config file, make a note of the file's location: - The path to the generated config file on your machine. - - ```bash - $CONFIG_FILE = {path_to}/config.bundle.json - ``` + === "`CONFIG_FILE`" + + The path to the generated config file on your machine. + + ```bash + $CONFIG_FILE = {path_to}/config.bundle.json + ``` + +=== "Assets archive" + + The **basemaps/server** package also allows you to specify the location of assets (e.g. fonts and sprites) to use when serving the **basemaps** system. + + !!! tip "Note" + + Specifying this location is not required to serve raster imagery. If you wish to serve vector imagery or view the labels overlay, you will need to specify this location. Otherwise, assets referenced by such layers will not load. + + === "Using the pre-generated assets archive" + + !!! abstract "Path" + + To use the exisiting assets archive stored in the **LINZ AWS S3** bucket, note the following path: + + === "`ASSETS_ARCHIVE`" + + The absolute path to the latest assets archive stored in the **LINZ AWS S3** bucket. + + ```bash + $ASSETS_ARCHIVE = s3://linz-basemaps/assets/assets-latest.tar.co + ``` + + === "Generating the assets archive yourself" + + To generate the assets archive yourself, follow the [**Bundle the `basemaps` assets archive**][bundle-the-basemaps-assets-archive] guide. Then, return to this section. + + !!! abstract "Path" + + Once you have generated the assets archive, make a note of the archive's location: + + === "`ASSETS_ARCHIVE`" + + The path to the generated assets archive on your machine. + + ```bash + $ASSETS_ARCHIVE = {path_to}/assets.bundle.tar.co + ``` ## Run the `basemaps/server` package -At this stage, you should have a path to a config file. Either, to that which you are sourcing from the **LINZ AWS S3** bucket, or, have generated using the **basemaps/cli** package. +At this stage, you should have a path to a config file. You may also have a path to an assets archive. Either of which you are sourcing from the **LINZ AWS S3** bucket, or, have generated using the **basemaps/cli** package. !!! abstract "Path" @@ -56,11 +94,19 @@ At this stage, you should have a path to a config file. Either, to that which yo ### Command -Use the following command to run the **basemaps** system: +Use one of the following commands to run the **basemaps** system: + +=== "Without assets" -```bash + ```bash node $BM_SERVER_BUILD/bin.js --config $CONFIG_FILE -``` + ``` + +=== "With assets" + + ```bash + node $BM_SERVER_BUILD/bin.js --config $CONFIG_FILE --assets $ASSETS_ARCHIVE + ``` ### Parameters @@ -68,6 +114,11 @@ Use the following command to run the **basemaps** system: Specifies the location of the bundled config file to use. +=== "`--assets`" + + Specifies the location of the bundled assets archive to use. + -[bundle-the-basemaps-config-file]: ../cli-methods/bundle-the-basemaps-config-file.md \ No newline at end of file +[bundle-the-basemaps-config-file]: ../cli-methods/bundle-the-basemaps-config-file.md +[bundle-the-basemaps-assets-archive]: ../cli-methods/bundle-the-basemaps-assets-archive.md From 03b5a3eb2d7cec93a8943985a99dccf6d504c4ee Mon Sep 17 00:00:00 2001 From: Tawera Manaena Date: Mon, 11 Nov 2024 09:29:49 +1300 Subject: [PATCH 7/7] docs: add --assets usage documentation --- .../bundle-the-basemaps-assets-archive.md | 80 ++++++++++++++++++- 1 file changed, 78 insertions(+), 2 deletions(-) diff --git a/docs/developer-guide/cli-methods/bundle-the-basemaps-assets-archive.md b/docs/developer-guide/cli-methods/bundle-the-basemaps-assets-archive.md index 85e04b0be..a4b8bacd6 100644 --- a/docs/developer-guide/cli-methods/bundle-the-basemaps-assets-archive.md +++ b/docs/developer-guide/cli-methods/bundle-the-basemaps-assets-archive.md @@ -55,6 +55,80 @@ Clone the [**linz/basemaps-config**][bm_config_repo] repository to your machine. ```bash $BM_SPRITES_BIN = $BM_REPO/packages/sprites/bin ``` + +## Generate the `basemaps` assets + +### 1. Create local directory + +To prepare for bundling the `basemaps` assets archive, create a local directory on your machine with the following subdirectory structure: + +```md +- assets + - fonts + - sprites +``` + +You can specify a location and directory name of your choice. + +!!! abstract "Path" + + On your machine, consider the following path: + + === "`ASSETS_DIR`" + + The path to the created directory on your machine. + + ```bash + $ASSETS_DIR = {path_to_directory} + ``` + +### 2. Convert fonts into `.pbf` (protobuf-encoded glyphs) files + +To generate the `basemaps` `.pbf` files, follow the instructions described in this [README.md][fonts_readme] file. Alternatively, there is a [repository][pbf_fonts_repo] containing various fonts that have already been converted into the `.pbf` format. + +Move the generated and/or downloaded collections of `.pbf` files **into** the following directory: + +``` +$ASSETS_DIR/assets/fonts +``` + +The contents of your `$ASSETS_DIR/assets/fonts` directory should look similar to the following: + +```md +- $ASSETS_DIR/assets/fonts + - Noto Sans Bold + - 0-255.pbf + - ... + - Open Sans Bold + - 0-255.pbf + - ... +``` + +### 3. Convert sprite files into sprite sheets + +Use the following command to generate the `basemaps` sprite sheets from the collection of topographic sprite files: + +```bash +node $BM_SPRITES_BIN/basemaps-sprites.mjs \ +$BM_CONFIG_REPO/config/sprites/topographic +``` + +The above command will output the resulting sprite sheets to the location from which you executed the command. Move the outputted files **into** the following directory: + +```md +$ASSETS_DIR/assets/sprites +``` + +The contents of your `$ASSETS_DIR/assets/sprites` directory should look similar to the following: + +```md +- $ASSETS_DIR/assets/sprites + - topographic.json + - topographic.png + - topographic@2x.json + - topographic@2x.png +``` + ## Run the `basemaps/cli` package ### Command @@ -63,7 +137,7 @@ Use the following command to bundle the `basemaps` assets archive: ```bash node $BM_CLI_BUILD/bin.js bundle-assets \ - --assets $BM_CONFIG_REPO/assets \ + --assets $ASSETS_DIR \ --output assets.bundle.tar.co \ ``` @@ -71,7 +145,7 @@ node $BM_CLI_BUILD/bin.js bundle-assets \ === "`--assets`" - Specifies the location of the assets folder to use. This folder refers to that of which is within the `basemaps-config` repository. + Specifies the location of the assets folder to use. This folder refers to that which contains the `.pbf` files and sprite sheets on your local machine. === "`--output`" @@ -80,3 +154,5 @@ node $BM_CLI_BUILD/bin.js bundle-assets \ [bm_config_repo]: https://github.com/linz/basemaps-config +[fonts_readme]: https://github.com/linz/basemaps-config/tree/master/config/fonts +[pbf_fonts_repo]: https://github.com/korywka/fonts.pbf