mapbox-gl-js-docs

Source of the Mapbox GL JS documentation website, with guidance on writing API docs and examples. It is for contributors who maintain that documentation.

Share on XLicense: BSD-3-Clause

Overview

This repository holds the source of the Mapbox GL JS documentation website. Its README is a contributor guide. API documentation is written as JSDoc comments and processed with documentation.js, and examples are Batfish pages with an HTML file and a front matter file plus an image. It also explains how to run the docs server locally.

Key features

  • API docs written as JSDoc comments with documentation.js
  • Style rules for class, function, member and event descriptions
  • Examples as Batfish pages with front matter and a screenshot
  • npm scripts to run the docs locally and create images

Best for

Contributors who write or maintain Mapbox GL JS API docs and examples. It is a documentation site source, not a mapping library.

Upstream
manson413/mapbox-gl-js-docs
Fork on GitHub
Guo-astro/mapbox-gl-js-docs
Upstream stars
2
Category
Maps and geospatial
License
BSD-3-Clause
Forked
2020-11-01
Sync status
In sync, has own commitsLast synced 2026-09-29