shadow/mkdocs.yml at main · GradleUp/shadow · 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
# pipx install mkdocs --include-deps
# pipx inject mkdocs mkdocs-material mdx_truly_sane_lists mkdocs-callouts
# mkdocs serve

site_name: Shadow Gradle Plugin
site_url: https://gradleup.com/shadow/
repo_name: Shadow
repo_url: https://github.com/GradleUp/shadow
site_description: "A Gradle plugin for creating fat/uber JARs, transforming files, relocating packages, and optimizing with R8/ProGuard. The Gradle counterpart to Maven Shade Plugin."
site_author: GradleUp developers
edit_uri: edit/main/docs
copyright: 'Copyright &copy; GradleUp developers'

theme:
  name: 'material'
  language: 'en'
  icon:
    repo: fontawesome/brands/github
  favicon: images/logo.orig.svg
  logo: images/logo.svg
  palette:
    - media: '(prefers-color-scheme)'
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: 'white'
      accent: 'indigo'
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: 'black'
      accent: 'indigo'
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  font:
    text: 'Lato'
    code: 'JetBrains Mono'
  features:
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - content.tabs.link
    - content.tooltips
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tracking
    - navigation.top
    - navigation.path
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share

plugins:
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - callouts: # TODO: https://github.com/mkdocs/mkdocs/issues/3997
      title_from_first_bold: true

markdown_extensions:
  - smarty
  - footnotes
  - meta
  - tables
  - admonition
  - attr_list
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: ['.']
  - 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.details
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.keys
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.magiclink
  - pymdownx.smartsymbols
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - mdx_truly_sane_lists:
      nested_indent: 2
      truly_sane: true

nav:
  - 'Introduction': README.md
  - 'Getting Started': getting-started/README.md
  - 'Configuration':
      - 'Overview': configuration/README.md
      - 'Filtering': configuration/filtering/README.md
      - 'Dependencies': configuration/dependencies/README.md
      - 'Merging': configuration/merging/README.md
      - 'Relocation': configuration/relocation/README.md
      - 'Minimizing': configuration/minimizing/README.md
      - 'Reproducible Builds': configuration/reproducible-builds/README.md
  - 'Custom Tasks': custom-tasks/README.md
  - 'Application Plugin': application-plugin/README.md
  - 'Kotlin Plugins': kotlin-plugins/README.md
  - 'Groovy and Scala Plugins': groovy-and-scala-plugins/README.md
  - 'Android Plugins': android-plugins/README.md
  - 'Publishing': publishing/README.md
  - 'Multi-Project': multi-project/README.md
  - 'Changes': changes/README.md
  - 'API ↗': api/index.html
  - 'About': about/README.md

validation:
  links:
    unrecognized_links: warn
    anchors: warn