url: https://evmo.github.io/protomapr/

template:
  bootstrap: 5

navbar:
  structure:
    left: [intro, reference, articles]
    right: [search, github]
  components:
    articles:
      text: Articles
      menu:
        - text: Getting Started
          href: articles/getting-started.html
        - text: Custom Styling
          href: articles/custom-styling.html
        - text: Data Visualization Basemaps
          href: articles/data-viz-basemaps.html
        - text: Labels and Filters
          href: articles/labels-and-filters.html

reference:
  - title: Add Protomaps to Maps
    desc: Core function for adding vector tile layers
    contents:
      - addProtomaps
      - protomapsOptions
      - protomapsDependency

  - title: Styles and Presets
    desc: Pre-built style configurations
    contents:
      - pmStyle
      - pmMinimal
      - pmModifyStyle
      - pmColors
      - pmHideFeatures
      - pmCityLabels
      - print.pm_style

  - title: Color Palettes
    desc: Apply color palettes to map features
    contents:
      - pmPalette
      - pmPaletteStyle

  - title: Custom Rules
    desc: Create custom paint and label rules
    contents:
      - pmPaintRule
      - pmLabelRule

  - title: Symbolizers
    desc: Visual appearance specifications
    contents:
      - pmPolygonSymbolizer
      - pmLineSymbolizer
      - pmCircleSymbolizer
      - pmTextSymbolizer
      - pmCenteredTextSymbolizer
      - pmLineLabelSymbolizer
      - pmShieldSymbolizer

  - title: Tile Sources
    desc: Functions for tile URLs and API keys
    contents:
      - protomaps_url
      - set_protomaps_key
      - protomaps_sample_tiles
      - protomaps_clear_cache

  - title: Reference Data
    desc: Documentation for layer properties
    contents:
      - protomaps_layers
      - protomaps_colors

articles:
  - title: Get Started
    navbar: ~
    contents:
      - getting-started
  - title: Customization
    contents:
      - custom-styling
      - labels-and-filters
  - title: Use Cases
    contents:
      - data-viz-basemaps

home:
  links:
    - text: Report a bug
      href: https://github.com/evmo/protomapr/issues