GeoDLKit/mkdocs.yml at main · jldz9/GeoDLKit · 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
site_name: GeoDLKit
repo_url: https://github.com/jldz9/GeoDLKit
repo_name: jldz9/GeoDLKit
site_url: https://jldz9.github.io/GeoDLKit/
theme:
  name: material
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - toc.follow
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      toggle:
        icon: material/weather-night
        name: switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: grey
      toggle:
        icon: material/weather-sunny
        name: switch to light mode
  icon:
    repo: fontawesome/brands/github

nav:
  - Home: index.md
  - Getting Start:
    - Installation: getting_start/index.md
    - Basic Usage: getting_start/basic_usage.md
  - Structure:
    - Overview: flowchart/main_program.md
    - Data Acquisition: flowchart/data_acquisition.md
  - About: about.md

extra:
  social:
    - icon: fontawesome/solid/envelope
      link: jiaweiliwork@outlook.com
      name: Email me
    - icon: fontawesome/brands/discord
      link: https://discord.gg/RJJM42MBUU
      name: Discord
  version:
    provider: mike

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.details:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - tables
  - md_in_html
  - pymdownx.blocks.caption


plugins:
  - search