UEAdvancedMaterialEditingLibrary/mkdocs.yml at main · edwardmakesthings/UEAdvancedMaterialEditingLibrary · 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
site_name: UE Advanced Material Editing Library
site_description: Documentation for the UE Advanced Material Editing Library plugin
repo_url: https://github.com/edwardmakesthings/UEAdvancedMaterialEditingLibrary
repo_name: edwardmakesthings/UEAdvancedMaterialEditingLibrary

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/favicon.png
  icon:
    logo: material/library
  font:
    code: Fira Code
  custom_dir: overrides
  features:
    - navigation.tabs
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - navigation.path
    - navigation.footer
    - toc.integrate
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - header.autohide
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - overrides/.icons
  - tables
  - toc:
      permalink: true

plugins:
  - mkdocs_transform_gh_readme
  - search
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - offline
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [Content/Python]
          selection:
            docstring_style: google
            members: true
          rendering:
            show_source: true
            show_root_heading: true
            heading_level: 2
            members_order: source
            show_if_no_docstring: false
            merge_init_into_class: true
            show_root_full_path: false
            separate_signature: true
            show_extension: false

nav:
  - Home: index.md
  - API Reference:
    - Layered Material Library: api/layered_material_library.md

watch:
  - .

extra:
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
  social:
    - icon: personal/jaworenko-design
      link: https://jaworenko.design
      name: My Website
    - icon: fontawesome/brands/github
      link: https://github.com/edwardmakesthings
      name: My Github
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/edwardmakesthings
      name: My LinkedIn

copyright: >
  Copyright &copy; 2024 - 2025  |  Edward Jaworenko –
  <a href="#__consent">Change cookie settings</a>