docs: make the docs overview prettier by CommanderStorm · Pull Request #7441 · maplibre/maplibre-gl-js

CommanderStorm · 2026-04-09T20:22:51Z

looks now like this:

Needs the "new"-label PR merged first to remove that from the diff, since that was simplest

codecov · 2026-04-09T20:33:54Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.77%. Comparing base (7f61f6f) to head (2bd78f3).
⚠️ Report is 11 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #7441   +/-   ##
=======================================
  Coverage   92.77%   92.77%           
=======================================
  Files         289      289           
  Lines       24017    24021    +4     
  Branches     5100     5100           
=======================================
+ Hits        22282    22286    +4     
  Misses       1735     1735

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

HarelM · 2026-04-09T21:31:34Z

build/generate-docs.ts

-
-${indexArrayItem.description}
+        const desc = indexArrayItem.description || '';
+        indexMarkdown += `<a class="example-card" href="./${indexArrayItem.mdFileName}">


Nope, sorry, markdown only, no HTML.
I've seen what happened to maplibre.io repo, it's full of HTML and CSS and it's unmaintainable. I don't want that here, sorry...

but that is simply impossible in pure markdown.
I cannot do a table that flexes from 1 to 3 element.

I also don't think this is unmaintanable..
It is fairly simple html and just where I cannot get away with this otherwise

You cannot with a straight face tell me that this is better...

HarelM · 2026-04-09T21:32:22Z

docs/assets/extra.css

 }
+
+/* Examples overview card grid */
+.examples-grid {


The opposite of KISS... I'd like to avoid this please.

I don't see a way to do this.

How can we get to a more overviewy Overview page without custom styling and without using any of zenzicals features?
It really does not make sense to me why you want this to be worse.

louwers · 2026-04-13T15:14:45Z

build/generate-docs.ts

+        }
+        return filenames;
+    } catch {
+        return new Set<string>();


This smells.

* Return empty array when custom protocol provides null array buffer * Add test * Add CHANGELOG entry * Better test name * Update tests to use vi.fn() * Convert to async/await * Move comment * Move comment

@CommanderStorm

* simplify a few examples * Apply suggestion from @CommanderStorm

@CommanderStorm

* fix typing in distanceToTile2d * minor typing adjustment in Bounds * add ensureError to passing any * change manual AJAXError in test to be the AJAXError * ensureError * tighten the this typing on some tests * fix typing in isAbortError * fix sligtly too wide typing in the actor * improve the pole of inaccessibility type savety * fix the benchmarks custom layer not conforming to the CustomLayerInterface * improve the leastSquaresRegression type * remove the unused call context capturing from throttle * add a type for RawGlyph * type for data shapes in glyph parsing * local/prefer-type-for-data-shapes * table a change for the futrue * use ensureError * Apply suggestion from @CommanderStorm

Bumps [jsdom](https://github.com/jsdom/jsdom) from 29.0.1 to 29.0.2. - [Release notes](https://github.com/jsdom/jsdom/releases) - [Commits](jsdom/jsdom@v29.0.1...v29.0.2) --- updated-dependencies: - dependency-name: jsdom dependency-version: 29.0.2 dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [basic-ftp](https://github.com/patrickjuchli/basic-ftp) from 5.2.1 to 5.2.2. - [Release notes](https://github.com/patrickjuchli/basic-ftp/releases) - [Changelog](https://github.com/patrickjuchli/basic-ftp/blob/master/CHANGELOG.md) - [Commits](patrickjuchli/basic-ftp@v5.2.1...v5.2.2) --- updated-dependencies: - dependency-name: basic-ftp dependency-version: 5.2.2 dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…ibre#7450) * Fix cache key * update changelog * gramar

* feat(marker): support number for opacity options Allow `opacity` and `opacityWhenCovered` in `Marker` and `MarkerOptions` to accept `number` in addition to `string`. This improves flexibility when setting marker opacity, making it easier to use numeric values directly. Includes tests for number-based opacity values. * feat(marker): add maplibregl-marker-occluded CSS class when occluded Add `maplibregl-marker-occluded` class to the marker element when it is occluded by 3D terrain or a globe, allowing custom styling via CSS. Also add an example demonstrating the feature. * refactor(marker): rename occluded class to covered Renames the marker CSS class from 'maplibregl-marker-occluded' to 'maplibregl-marker-covered' for clarity and consistency. * fix(marker): update setOpacity JSDoc param descriptions * fix(marker): remove covered class when marker is visible Removes the 'maplibregl-marker-covered' class from the marker element when the marker is determined to be visible (not covered by terrain). * test(marker): add tests for marker covered state Add tests to verify that the 'maplibregl-marker-covered' class is added or removed on markers when they are covered by 3D terrain or globe projection. * docs(marker): update CSS class docs and remove example - Updated the Marker API docs to describe the `maplibregl-marker-covered` CSS class for styling markers hidden behind 3D terrain or on the back of a globe. - Removed the obsolete "Style markers when occluded" HTML example, as the CSS class documentation now covers its usage. * docs(changelog): rename occluded CSS class to covered Update changelog to reflect renaming of marker CSS class from `maplibregl-marker-occluded` to `maplibregl-marker-covered` for clarity.

* fix: guard against null style in _contextRestored When a map is initialized without a style, the WebGL context restore handler would throw because this.style is null. Add a null check before accessing this.style.imageManager. Fixes maplibre#7432 * test: remove unnecessary comment per review * Fix error in _contextRestored for map initialization --------- Co-authored-by: Matt Van Horn <455140+mvanhorn@users.noreply.github.com> Co-authored-by: Harel M <harel.mazor@gmail.com>

* Adds global dispatcher and make request. * Updage changelog. * Fix build * Update comment to use function instead of method.

* chore(deps-dev): bump stylelint from 16.26.1 to 17.6.0 Bumps [stylelint](https://github.com/stylelint/stylelint) from 16.26.1 to 17.6.0. - [Release notes](https://github.com/stylelint/stylelint/releases) - [Changelog](https://github.com/stylelint/stylelint/blob/main/CHANGELOG.md) - [Commits](stylelint/stylelint@16.26.1...17.6.0) --- updated-dependencies: - dependency-name: stylelint dependency-version: 17.6.0 dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> * Fix css, update packages --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Harel M <harel.mazor@gmail.com>

…e#7358) Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 5.5.3 to 6.0.0. - [Release notes](https://github.com/codecov/codecov-action/releases) - [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md) - [Commits](codecov/codecov-action@1af5884...57e3a13) --- updated-dependencies: - dependency-name: codecov/codecov-action dependency-version: 6.0.0 dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Update geojson-vt to latest version * Update bundle_size.

* Bump js version to 5.23.0 * Update CHANGELOG with recent changes and fixes --------- Co-authored-by: HarelM <3269297+HarelM@users.noreply.github.com> Co-authored-by: Harel M <harel.mazor@gmail.com>

Bumps the vitest group with 4 updates: [@vitest/coverage-v8](https://github.com/vitest-dev/vitest/tree/HEAD/packages/coverage-v8), [@vitest/eslint-plugin](https://github.com/vitest-dev/eslint-plugin-vitest), [@vitest/ui](https://github.com/vitest-dev/vitest/tree/HEAD/packages/ui) and [vitest](https://github.com/vitest-dev/vitest/tree/HEAD/packages/vitest). Updates `@vitest/coverage-v8` from 4.1.2 to 4.1.4 - [Release notes](https://github.com/vitest-dev/vitest/releases) - [Commits](https://github.com/vitest-dev/vitest/commits/v4.1.4/packages/coverage-v8) Updates `@vitest/eslint-plugin` from 1.6.14 to 1.6.15 - [Release notes](https://github.com/vitest-dev/eslint-plugin-vitest/releases) - [Commits](vitest-dev/eslint-plugin-vitest@v1.6.14...v1.6.15) Updates `@vitest/ui` from 4.1.2 to 4.1.4 - [Release notes](https://github.com/vitest-dev/vitest/releases) - [Commits](https://github.com/vitest-dev/vitest/commits/v4.1.4/packages/ui) Updates `vitest` from 4.1.2 to 4.1.4 - [Release notes](https://github.com/vitest-dev/vitest/releases) - [Commits](https://github.com/vitest-dev/vitest/commits/v4.1.4/packages/vitest) --- updated-dependencies: - dependency-name: "@vitest/coverage-v8" dependency-version: 4.1.4 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: vitest - dependency-name: "@vitest/eslint-plugin" dependency-version: 1.6.15 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: vitest - dependency-name: "@vitest/ui" dependency-version: 4.1.4 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: vitest - dependency-name: vitest dependency-version: 4.1.4 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: vitest ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [cspell](https://github.com/streetsidesoftware/cspell/tree/HEAD/packages/cspell) from 9.8.0 to 10.0.0. - [Release notes](https://github.com/streetsidesoftware/cspell/releases) - [Changelog](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell/CHANGELOG.md) - [Commits](https://github.com/streetsidesoftware/cspell/commits/v10.0.0/packages/cspell) --- updated-dependencies: - dependency-name: cspell dependency-version: 10.0.0 dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [react](https://github.com/facebook/react/tree/HEAD/packages/react) from 19.2.4 to 19.2.5. - [Release notes](https://github.com/facebook/react/releases) - [Changelog](https://github.com/facebook/react/blob/main/CHANGELOG.md) - [Commits](https://github.com/facebook/react/commits/v19.2.5/packages/react) --- updated-dependencies: - dependency-name: react dependency-version: 19.2.5 dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [@mapbox/tiny-sdf](https://github.com/mapbox/tiny-sdf) from 2.0.7 to 2.1.0. - [Release notes](https://github.com/mapbox/tiny-sdf/releases) - [Commits](mapbox/tiny-sdf@v2.0.7...v2.1.0) --- updated-dependencies: - dependency-name: "@mapbox/tiny-sdf" dependency-version: 2.1.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…maplibre#7462) Bumps [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/parser) from 8.58.0 to 8.58.1. - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases) - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/parser/CHANGELOG.md) - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v8.58.1/packages/parser) --- updated-dependencies: - dependency-name: "@typescript-eslint/parser" dependency-version: 8.58.1 dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [react-dom](https://github.com/facebook/react/tree/HEAD/packages/react-dom) from 19.2.4 to 19.2.5. - [Release notes](https://github.com/facebook/react/releases) - [Changelog](https://github.com/facebook/react/blob/main/CHANGELOG.md) - [Commits](https://github.com/facebook/react/commits/v19.2.5/packages/react-dom) --- updated-dependencies: - dependency-name: react-dom dependency-version: 19.2.5 dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [postcss](https://github.com/postcss/postcss) from 8.5.8 to 8.5.9. - [Release notes](https://github.com/postcss/postcss/releases) - [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md) - [Commits](postcss/postcss@8.5.8...8.5.9) --- updated-dependencies: - dependency-name: postcss dependency-version: 8.5.9 dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 8.58.0 to 8.58.1. - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases) - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/CHANGELOG.md) - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v8.58.1/packages/eslint-plugin) --- updated-dependencies: - dependency-name: "@typescript-eslint/eslint-plugin" dependency-version: 8.58.1 dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 25.5.2 to 25.6.0. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node) --- updated-dependencies: - dependency-name: "@types/node" dependency-version: 25.6.0 dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

build/generate-docs.ts

split html and js

a00f580

CommanderStorm requested a review from HarelM April 9, 2026 20:22

CommanderStorm added 2 commits April 9, 2026 22:38

Apply suggestion from @CommanderStorm

8c90ee8

fix lints

1a441f6

HarelM reviewed Apr 9, 2026

View reviewed changes

louwers reviewed Apr 13, 2026

View reviewed changes

build/generate-docs.ts Outdated

}

return filenames;

} catch {

return new Set<string>();

Copy link
Copy Markdown

Member

louwers Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This smells.

CommanderStorm and others added 22 commits April 14, 2026 01:32

move the dates to git

f2c4dc3

fix fmt

1a6c6e1

make the docs overview prettier

8137a39

Handle null custom protocol array buffer response (maplibre#7427)

ee8d137

* Return empty array when custom protocol provides null array buffer * Add test * Add CHANGELOG entry * Better test name * Update tests to use vi.fn() * Convert to async/await * Move comment * Move comment

change all terrrain examples to mapterhorn (maplibre#7431)

114a21c

document zoom direction clearer (maplibre#7438)

801303a

docs: simplify a few examples (maplibre#7439)

d07c880

* simplify a few examples * Apply suggestion from @CommanderStorm

Fix cache key for _zoomLevelsToOverscale experimental feature (mapl…

0fae734

…ibre#7450) * Fix cache key * update changelog * gramar

Improve ability to import scripts in workers (maplibre#7451)

218c157

* Adds global dispatcher and make request. * Updage changelog. * Fix build * Update comment to use function instead of method.

test (maplibre#7452)

c32329a

Update geojson-vt to version 6.1.0 (maplibre#7454)

15fde5d

* Update geojson-vt to latest version * Update bundle_size.

Bump js version to 5.23.0 (maplibre#7455)

4662f0b

* Bump js version to 5.23.0 * Update CHANGELOG with recent changes and fixes --------- Co-authored-by: HarelM <3269297+HarelM@users.noreply.github.com> Co-authored-by: Harel M <harel.mazor@gmail.com>

dependabot bot added 6 commits April 14, 2026 01:52

CommanderStorm force-pushed the docs-overview branch from 35d0dd4 to da24f33 Compare April 13, 2026 23:56

Merge branch 'main' into docs-overview

989b1b9

CommanderStorm commented Apr 13, 2026

View reviewed changes

build/generate-docs.ts Show resolved Hide resolved

Apply suggestion from @CommanderStorm

2bd78f3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: make the docs overview prettier#7441

docs: make the docs overview prettier#7441
CommanderStorm wants to merge 33 commits intomaplibre:mainfrom
CommanderStorm:docs-overview

CommanderStorm commented Apr 9, 2026

Uh oh!

codecov bot commented Apr 9, 2026 •

edited

Loading

Uh oh!

HarelM Apr 9, 2026

Uh oh!

CommanderStorm Apr 9, 2026

Uh oh!

HarelM Apr 9, 2026

Uh oh!

CommanderStorm Apr 9, 2026

Uh oh!

louwers Apr 13, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Uh oh!

Conversation

CommanderStorm commented Apr 9, 2026

Uh oh!

codecov bot commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

HarelM Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

CommanderStorm Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

HarelM Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

CommanderStorm Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

louwers Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

codecov bot commented Apr 9, 2026 •

edited

Loading