sketch/mkdocs.yml at main · 0sten/sketch · 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
133
134
135
136
137
138
139
140
141
142
143
144
145
# Built with https://github.com/squidfunk/mkdocs-material

site_name: 'Sketch Image Loader'
site_url: 'https://github.com/panpf/sketch'
site_author: '2024 panpf'
site_description: 'An image loading library designed for Compose Multiplatform and Android View. It is powerful and rich in functions. In addition to basic functions, it also supports GIF, SVG, video thumbnails, Exif Orientation, etc.'

repo_name: 'Sketch'
repo_url: 'https://github.com/panpf/sketch'

copyright: 'Copyright &copy; 2024 panpf'

theme:
  name: 'material'
  language: 'en'
  favicon: 'images/logo.ico'
  logo: 'images/logo.png'
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: white
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: black
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: 'JetBrains'
    code: 'JetBrains Mono'
  features:
    - content.tabs
    - content.code.annotate
    - content.code.copy
    #    - navigation.tabs
    #    - navigation.top
    - navigation.indexes
    - navigation.sections
    - navigation.expand
    - navigation.footer
    - navigation.instant
    - navigation.tracking
    - search.highlight
    - search.suggest
    - search.share

extra:
  social:
    - icon: 'fontawesome/brands/github'
      link: 'https://github.com/panpf/sketch'

nav:
  - 'Overview': index.md
  - 'Getting Started': getting_started.md
  - 'Register Component': register_component.md
  - 'Compose': compose.md
  - 'Http': http.md
  - 'Animated Image': animated_image.md
  - 'Resize': resize.md
  - 'Transformation': transformation.md
  - 'Transition': transition.md
  - 'StateImage': state_image.md
  - 'Listener': listener.md
  - 'DownloadCache': download_cache.md
  - 'ResultCache': result_cache.md
  - 'MemoryCache': memory_cache.md
  - 'Fetcher': fetcher.md
  - 'Decoder': decoder.md
  - 'Target': target.md
  - 'SVG': svg.md
  - 'Video Frames': video_frame.md
  - 'BlurHash': blurhash.md
  - 'Exif Orientation': exif_orientation.md
  - 'ImageOptions': image_options.md
  - 'RequestInterceptor': request_interceptor.md
  - 'DecodeInterceptor': decode_interceptor.md
  - 'Preload': preload.md
  - 'Download Image': download_image.md
  - 'Lifecycle': lifecycle.md
  - 'SketchImageView': sketch_image_view.md
  - 'Clearer Thumbnail': long_image_grid_thumbnails.md
  - 'Progress Indicator': progress_indicator.md
  - 'Mime Type Logo': mime_type_logo.md
  - 'Save Cellular Data': save_cellular_traffic.md
  - 'Pause Load When Scrolling': pause_load_when_scrolling.md
  - 'Apk/App Icon': apk_app_icon.md
  - 'Log': log.md
  - 'Migrate': migrate.md
  - 'Change Log': CHANGELOG.md

markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences  # Support code block nesting
  - pymdownx.tabbed       # Support tabs
  - pymdownx.tasklist     # Supported task list
  - pymdownx.emoji        # Support Emoji
  - pymdownx.details      # Supports folded content
  - pymdownx.highlight    # Support code highlighting
  - tables                # Support Form
  - footnotes             # Support footnotes
  - attr_list             # Supported attribute list
  - md_in_html            # Support embedding Markdown in HTML

plugins:
  - i18n:
      docs_structure: suffix
      default_language: en
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: zh
          default: false
          name: 中文
          build: true
  - search
  - minify:
      minify_html: true

validation:
  #  links:
  #    absolute_links: ignore
  nav:
    omitted_files: ignore