DreamLayer/mkdocs.yml at main · Yanming99/DreamLayer · 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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
site_name: DreamLayer AI
site_description: The Cleanest, Fastest Stable Diffusion WebUI
site_author: DreamLayer AI Team
site_url: https://dreamlayer-ai.github.io/DreamLayer

# Repository
repo_name: DreamLayer-AI/DreamLayer
repo_url: https://github.com/DreamLayer-AI/DreamLayer
edit_uri: edit/main/docs/

# Theme
theme:
  name: material
  language: en
  palette:
    # Palette toggle for automatic mode
    - scheme: default
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - scheme: slate
      toggle:
        icon: material/brightness-7
        name: Switch to system preference
    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode

  # Features
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tabs.link
    - content.tooltips
    - header.autohide
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.delay
    - navigation.instant.loading
    - navigation.instant.preload
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.instant.result
    - navigation.instant.suggest
    - navigation.instant.tabs
    - navigation.instant.typesense
    - navigation.prune
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - navigation.footer
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

  # Icon
  icon:
    repo: fontawesome/brands/github

# Navigation
nav:
  - Home: index.md
  - Getting Started:
    - Quick Start: quick_start.md
    - Installation: installation.md
    - Usage Guide: usage.md
  - Technical Documentation:
    - Architecture: architecture.md
    - API Reference: api_reference.md
    - Modules:
      - Generator: modules/generator.md
      - Utils: modules/utils.md
  - Development:
    - Contributing: contributing.md
    - Changelog: changelog.md

# Plugins
plugins:
  - search
  - mermaid2:
      arguments:
        theme: default
        themeVariables:
          primaryColor: "#2196F3"
          primaryTextColor: "#fff"
          primaryBorderColor: "#1976D2"
          lineColor: "#666"
          secondaryColor: "#f0f0f0"
          tertiaryColor: "#fff"

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Extra CSS
extra_css:
  - stylesheets/extra.css

# Extra JavaScript
extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

# Copyright
copyright: Copyright &copy; 2024 DreamLayer AI Team

# Social
social:
  - icon: fontawesome/brands/github
    link: https://github.com/DreamLayer-AI/DreamLayer
  - icon: fontawesome/brands/discord
    link: https://discord.gg/dreamlayer
  - icon: fontawesome/brands/twitter
    link: https://twitter.com/DreamLayerAI

# Analytics
google_analytics:
  - G-XXXXXXXXXX
  - auto

# Validation
validation:
  nav:
    omitted_files: ignore
  not_found: warn