-
Notifications
You must be signed in to change notification settings - Fork 10
/
mkdocs.yml
147 lines (138 loc) · 3.86 KB
/
mkdocs.yml
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
####
# NOTE: This documentation is for the experimental deployment and local development
# The final documentaiton will be under gradle.org
####
site_name: Declarative Gradle
site_description: >-
Declarative Gradle is a project targeting better isolation of concern
and expressing any build in a clear and understandable way
copyright: >
For content - Copyright © 2024 - All contributors to the repository and included components.
The original content licenses and copyrights from the included repositories are preserved,
you can find them in the linked repositories.
The GRADLE trademark is the property of Gradle, Inc.
docs_dir: .
repo_url: https://github.com/gradle/declarative-gradle
repo_name: Declarative Gradle repo
edit_uri: edit/main/
site_url: https://gradle.github.io/declarative-gradle
# Build
site_dir: _site
# Theme
theme:
name: material
highlightjs: true
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
# NOT compatible qith toc.integrate
# - navigation.indexes
- navigation.path
# - navigation.instant
# - navigation.instant.prefetch
# - navigation.instant.progress
# - navigation.prune
- navigation.sections
- navigation.expand
- navigation.tabs
# - navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
- toc.integrate
palette:
- scheme: default
media: "(prefers-color-scheme: light)"
primary: custom
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
media: "(prefers-color-scheme: dark)"
primary: custom
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
# TODO: use the site's scheme
# text: Lato Lite
code: Roboto Mono
favicon: docs/images/logos/gradle.svg
logo: docs/images/logos/gradle.svg
icon:
repo: fontawesome/brands/github
nav:
- Home: README.md
- About:
Overview: README.md
Getting Started: docs/getting-started/README.md
Declarative Gradle for Android: docs/android/README.md
Declarative Gradle for Java/JVM: docs/java/README.md
Declarative Gradle for Kotlin: docs/kotlin/README.md
Public Roadmap: ROADMAP.md
- Getting Started:
Overview: docs/getting-started/README.md
Android: docs/android/README.md
- Documentation:
Android: docs/android/README.md
Prototypes: unified-prototype/README.md
- Participate:
Contributing: docs/CONTRIBUTING.md
Code of Conduct: docs/CODE_OF_CONDUCT.md
extra_css:
- docs/assets/css/gradle.css
extra:
social:
- icon: fontawesome/brands/slack
link: https://gradle.org/slack-invite
name: Slack
- icon: fontawesome/brands/github
link: https://github.com/gradle
name: GitHub
- icon: fontawesome/brands/twitter
link: https://twitter.com/gradle
name: Twitter/X
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/gradle
name: LinkedIn
- icon: fontawesome/brands/mastodon
link: https://mastodon.social/@Gradle
name: Mastodon
# analytics:
# provider: google
# property: TODO
plugins:
- search
- autorefs
# FIXME: Collision on GitHub Actions, to be fixed later
# - macros
- mkdocs-pdf
- social
- same-dir
- include-markdown
# Markdown
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- toc:
permalink: '#'
- attr_list