GeoLeaf Core — Documentation Index
Package: @geoleaf/coreVersion: 3.0.0 License: MIT
Documentation for the GeoLeaf Core library (MIT only). This index covers the public core package only. Each plugin ships its own documentation in its npm package. For available plugins, visit geoleaf.dev.
Quick links
| Document | Description |
|---|---|
| Getting Started | Installation and first map — v3.0.0 |
| Quickstart Tutorial | End-to-end project (store locator) — v3.0.0 |
| User Guide | Complete feature documentation — v3.0.0 |
| Configuration Guide | JSON configuration reference — v3.0.0 |
| API Reference | Public API — facades & ESM exports — v3.0.0 |
| Architecture Guide | Design, boot sequence, modules — v3.0.0 |
| Direction | What GeoLeaf is for, and what it guarantees — v3.x |
| Plugin Development Guide | Plugin pattern, for repository contributors — v3.0.0 |
| Connector Guide → shipped by the plugin | HTTP authentication (@geoleaf-plugins/connector) — v3.0.0 |
| Contributing | Contribution guidelines — v3.0.0 |
User & configuration
- Getting Started — Installation, two initialization modes, first steps — v3.0.0
- Quickstart Tutorial — Complete end-to-end project with a profile — v3.0.0
- User Guide — Features and usage — v3.0.0
- Configuration Guide — Profile and layer configuration — v3.0.0
- Profiles Guide — Custom business profiles — v3.0.0
- Profile JSON Reference — Schema and fields (120+ parameters) — v3.0.0
- Plugin Configuration Guide — Plugin-related profile keys (storage, addpoi) — v3.0.0
- CDN / ESM usage — NPM and CDN integration — v3.0.0
- FAQ — Common questions and troubleshooting — v3.0.0
- Cookbook — Practical recipes — v3.0.0
- Accessibility — RGAA 4.1 compliance — v3.0.0
- PWA — Progressive Web App: configuration, deployment, install prompt
Developer
- Architecture Guide — Boot sequence, in-core capabilities, plugin registry — v3.0.0
- Direction — What GeoLeaf is for, what it is not, and what it guarantees — v3.x
- Plugin Development Guide — The plugin pattern, for contributors inside the repository (ESM pattern, globalThis bridge, PluginRegistry) — v3.0.0
- Connector Guide — Transparent HTTP authentication with @geoleaf-plugins/connector (MIT) — v3.0.0. The guide is not part of this package: it ships with the plugin package, at
docs/CONNECTOR_GUIDE.md(repository:packages/plugins/connector/docs/CONNECTOR_GUIDE.md) - Contributing — Monorepo workflow, conventions, TSDoc — v3.0.0
- Versioning Policy — SemVer policy — v3.0.0
- Performance Metrics — Runtime metrics — v3.0.0
API reference
- API Reference — 27 named ESM exports + public facades + global namespace — v3.0.0
- Events API — Event bus, event types — v3.0.0
- Notifications API — Notification system API — v3.0.0
- TypeDoc (generated) — Run
npm run docs:apiinpackages/coreto generate locally atpackages/core/docs/api/
Module documentation
Core modules
Schema
| Topic | Document | Version |
|---|---|---|
| Schemas | schema/README.md | v3.0.0 |
Legal
| Document | Description |
|---|---|
| NOTICE.md | Third-party notices and attributions |
Plugins
Public MIT plugin
- @geoleaf-plugins/connector — Transparent HTTP authentication (fetch interception, JWT, login modal). Documentation:
packages/plugins/connector/README.mdandpackages/plugins/connector/docs/CONNECTOR_GUIDE.md, both shipped by the plugin package
Commercial plugins
Plugin documentation is not duplicated here — it ships inside each @geoleaf-plugins/* package.
- @geoleaf-plugins/offline-ui — Offline cache, IndexedDB, tile persistence
For plugin configuration inside a profile: PLUGIN_CONFIGURATION_GUIDE.md
Visit geoleaf.dev for licensing information.