anymap-ts/mkdocs.yml at main · technigami/anymap-ts · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
site_name: anymap-ts
site_description: A Python package for creating interactive maps with anywidget and TypeScript
site_author: giswqs
site_url: https://ts.anymap.dev
repo_url: https://github.com/opengeos/anymap-ts

copyright: "Copyright &copy; 2025 Qiusheng Wu"

theme:
    palette:
        - scheme: default
          #   primary: blue
          #   accent: indigo
          toggle:
              icon: material/toggle-switch-off-outline
              name: Switch to dark mode
        - scheme: slate
          primary: indigo
          accent: indigo
          toggle:
              icon: material/toggle-switch
              name: Switch to light mode
    name: material
    icon:
        repo: fontawesome/brands/github
    # logo: assets/logo.png
    # favicon: assets/favicon.png
    features:
        - navigation.instant
        - navigation.tracking
        - navigation.top
        - search.highlight
        - search.share
    custom_dir: "docs/overrides"
    font:
        text: Google Sans
        code: Regular

plugins:
    - search
    - mkdocstrings
    - git-revision-date
    - git-revision-date-localized:
          enable_creation_date: true
          type: timeago
    # - pdf-export
    - mkdocs-jupyter:
          include_source: True
          ignore_h1_titles: True
          execute: false
          allow_errors: false
          ignore: ["conf.py"]
          execute_ignore: ["*ignore.ipynb"]

markdown_extensions:
    - admonition
    - abbr
    - attr_list
    - def_list
    - footnotes
    - meta
    - md_in_html
    - pymdownx.superfences
    - pymdownx.highlight:
          linenums: true
    - toc:
          permalink: true

extra_css:
    - stylesheets/extra.css

# extra:
#     analytics:
#         provider: google
#         property: UA-XXXXXXXXX-X

nav:
    - Home: index.md
    - Installation: installation.md
    - Usage: usage.md
    - Contributing: contributing.md
    - Changelog: https://github.com/opengeos/anymap-ts/releases
    - Report Issues: https://github.com/opengeos/anymap-ts/issues
    - Live Examples: examples/index.html
    - TypeScript:
          - Overview: typescript/index.md
          - Examples:
                - MapLibre: typescript/examples/maplibre.md
                - Leaflet: typescript/examples/leaflet.md
                - Mapbox: typescript/examples/mapbox.md
                - Cesium: typescript/examples/cesium.md
                - DeckGL: typescript/examples/deckgl.md
                - OpenLayers: typescript/examples/openlayers.md
                - Potree: typescript/examples/potree.md
                - KeplerGL: typescript/examples/keplergl.md
                - COG Layer: typescript/examples/cog_layer.md
                - Zarr Layer: typescript/examples/zarr_layer.md
    - Cesium:
          - notebooks/cesium.ipynb
    - DeckGL:
          - notebooks/deckgl.ipynb
    - KeplerGL:
          - notebooks/keplergl.ipynb
    - Leaflet:
          - notebooks/leaflet.ipynb
    - MapLibre:
          - notebooks/maplibre.ipynb
          - notebooks/control_grid.ipynb
          - notebooks/cog_layer.ipynb
          - notebooks/zarr_layer.ipynb
          - notebooks/arc_layer.ipynb
          - notebooks/pointcloud_layer.ipynb
          - notebooks/ui_controls.ipynb
    - Mapbox:
          - notebooks/mapbox.ipynb
    - OpenLayers:
          - notebooks/openlayers.ipynb
    - Potree:
          - notebooks/potree.ipynb
    - API Reference:
          - anymap_ts module: anymap_ts.md
          - base module: base.md
          - basemaps module: basemaps.md
          - maplibre module: maplibre.md
          - mapbox module: mapbox.md
          - leaflet module: leaflet.md
          - openlayers module: openlayers.md
          - deckgl module: deckgl.md
          - cesium module: cesium.md
          - keplergl module: keplergl.md
          - potree module: potree.md
          - utils module: utils.md