mkdocs.yml

site_name: TiTiler
site_description: A lightweight service for creating map tiles from Cloud-Optimized GeoTiff

repo_name: "developmentseed/titiler"
repo_url: "https://github.com/developmentseed/titiler"

extra:
  social:
    - icon: "fontawesome/brands/github"
      link: "https://github.com/developmentseed"
    - icon: "fontawesome/brands/twitter"
      link: "https://twitter.com/developmentseed"
    - icon: "fontawesome/brands/medium"
      link: "https://medium.com/devseed"

nav:
  - TiTiler: "index.md"
  - User Guide:
    - Intro: "intro.md"
    - Endpoints Documentation:
        - Cloud Optimized GeoTIFF: "endpoints/cog.md"
        - MosaicJSON: "endpoints/mosaic.md"
        - SpatioTemporal Asset Catalog: "endpoints/stac.md"
        - TileMatrixSets: "endpoints/tms.md"
  - Advanced User Guide:
      - "concepts/tiler_factories.md"
      - "concepts/dependencies.md"
      - "concepts/customization.md"
      - "concepts/APIRoute_and_environment_variables.md"
      # - "concepts/dynamic_tiling.md"
      # - "concepts/data_formats.md"
      # - "concepts/tile_matrix_sets.md"
  - Examples:
    - COG: "examples/Working_with_CloudOptimizedGeoTIFF_simple.ipynb"
    - COG at scale: "examples/Working_with_CloudOptimizedGeoTIFF.ipynb"
    - STAC: "examples/Working_with_STAC_simple.ipynb"
    - STAC at scale: "examples/Working_with_STAC.ipynb"
    - MosaicJSON: "examples/Working_with_MosaicJSON.ipynb"
    - Non-WebMercator TMS: "examples/Working_with_nonWebMercatorTMS.ipynb"
    - Custom Sentinel 2 Tiler: "examples/Create_CustomSentinel2Tiler.ipynb"
  - Deployment:
      - "deployment/settings.md"
      - "deployment/ecs.md"
      - "deployment/lambda.md"
  - Development - Contributing: "contributing.md"
  - Release Notes: "release-notes.md"

plugins:
  - search
  - mkdocs-jupyter:
      include_source: True

theme:
  name: material
  palette:
    primary: indigo
    scheme: default
  custom_dir: 'docs/overrides'

# https://github.com/kylebarron/cogeo-mosaic/blob/mkdocs/mkdocs.yml#L50-L75
markdown_extensions:
  - admonition
  - attr_list
  - codehilite:
      guess_lang: false
  - def_list
  - footnotes
  - pymdownx.arithmatex
  - pymdownx.betterem
  - pymdownx.caret:
      insert: false
  - pymdownx.details
  - pymdownx.emoji
  - pymdownx.escapeall:
      hardbreak: true
      nbsp: true
  - pymdownx.magiclink:
      hide_protocol: true
      repo_url_shortener: true
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - toc:
      permalink: true