@panoramax/web-viewer/mkdocs.yml

Panoramax web viewer for geolocated pictures

site_name: 'Panoramax - Web viewer'
site_url: https://docs.panoramax.fr

theme:
  name: material
  logo: https://gitlab.com/panoramax/gitlab-profile/-/raw/main/images/panoramax_favicon.svg
  features:
    - navigation.footer
    - navigation.tracking
    - navigation.sections
    - search.suggest
    - search.share
    - content.code.annotate
    - content.code.copy
    - content.code.select

plugins:
  - search

markdown_extensions:
  - admonition
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - 'Quick start': 'index.md'
  - 'Migrating to v4': 'tutorials/migrate_v4.md'
  - Tips:
    - 'URL settings': '03_URL_settings.md'
    - Shortcuts: 'shortcuts.md'
  - Tutorials:
    - 'Change map style': 'tutorials/map_style.md'
    - 'Add aerial imagery': 'tutorials/aerial_imagery.md'
    - 'Server authentication': 'tutorials/authentication.md'
    - 'Custom widgets': 'tutorials/custom_widgets.md'
    - 'Synced coverage map': 'tutorials/synced_coverage.md'
  - Develop:
    - 'Where to start': '09_Develop.md'
    - 'STAC API compatibility': '05_Compatibility.md'
    - 'Make a release': '90_Releases.md'
  - 'API reference':
    - Overview: 'reference.md'
    - components:
      - core:
        - Basic: 'reference/components/core/Basic.md'
        - CoverageMap: 'reference/components/core/CoverageMap.md'
        - Editor: 'reference/components/core/Editor.md'
        - PhotoViewer: 'reference/components/core/PhotoViewer.md'
        - Viewer: 'reference/components/core/Viewer.md'
      - layout:
        - BottomDrawer: 'reference/components/layout/BottomDrawer.md'
        - CorneredGrid: 'reference/components/layout/CorneredGrid.md'
        - Mini: 'reference/components/layout/Mini.md'
        - Tabs: 'reference/components/layout/Tabs.md'
      - menus:
        - AnnotationsList: 'reference/components/menus/AnnotationsList.md'
        - MapBackground: 'reference/components/menus/MapBackground.md'
        - MapFilters: 'reference/components/menus/MapFilters.md'
        - MapLayers: 'reference/components/menus/MapLayers.md'
        - MapLegend: 'reference/components/menus/MapLegend.md'
        - MiniPictureLegend: 'reference/components/menus/MiniPictureLegend.md'
        - PictureLegend: 'reference/components/menus/PictureLegend.md'
        - PictureMetadata: 'reference/components/menus/PictureMetadata.md'
        - PlayerOptions: 'reference/components/menus/PlayerOptions.md'
        - QualityScoreDoc: 'reference/components/menus/QualityScoreDoc.md'
        - ReportForm: 'reference/components/menus/ReportForm.md'
        - ShareMenu: 'reference/components/menus/ShareMenu.md'
      - ui:
        - widgets:
          - CopyCoordinates: 'reference/components/ui/widgets/CopyCoordinates.md'
          - GeoSearch: 'reference/components/ui/widgets/GeoSearch.md'
          - Legend: 'reference/components/ui/widgets/Legend.md'
          - MapFiltersButton: 'reference/components/ui/widgets/MapFiltersButton.md'
          - MapLayersButton: 'reference/components/ui/widgets/MapLayersButton.md'
          - OSMEditors: 'reference/components/ui/widgets/OSMEditors.md'
          - PictureLegendActions: 'reference/components/ui/widgets/PictureLegendActions.md'
          - Player: 'reference/components/ui/widgets/Player.md'
          - Zoom: 'reference/components/ui/widgets/Zoom.md'
        - AnnotationsSwitch: 'reference/components/ui/AnnotationsSwitch.md'
        - Button: 'reference/components/ui/Button.md'
        - ButtonGroup: 'reference/components/ui/ButtonGroup.md'
        - CopyButton: 'reference/components/ui/CopyButton.md'
        - Grade: 'reference/components/ui/Grade.md'
        - LinkButton: 'reference/components/ui/LinkButton.md'
        - ListGroup: 'reference/components/ui/ListGroup.md'
        - ListItem: 'reference/components/ui/ListItem.md'
        - Loader: 'reference/components/ui/Loader.md'
        - Map: 'reference/components/ui/Map.md'
        - MapMore: 'reference/components/ui/MapMore.md'
        - Photo: 'reference/components/ui/Photo.md'
        - Popup: 'reference/components/ui/Popup.md'
        - ProgressBar: 'reference/components/ui/ProgressBar.md'
        - QualityScore: 'reference/components/ui/QualityScore.md'
        - SearchBar: 'reference/components/ui/SearchBar.md'
        - SemanticsEditor: 'reference/components/ui/SemanticsEditor.md'
        - SemanticsTable: 'reference/components/ui/SemanticsTable.md'
        - TogglableGroup: 'reference/components/ui/TogglableGroup.md'
    - utils:
      - API: 'reference/utils/API.md'
      - InitParameters: 'reference/utils/InitParameters.md'
      - URLHandler: 'reference/utils/URLHandler.md'