Skip to content

Commit 9513211

Browse files
committed
feat: enable new mkdocs-material features
1 parent 2337d22 commit 9513211

File tree

4 files changed

+31
-1
lines changed

4 files changed

+31
-1
lines changed

docs/discord/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,9 @@ The [cloud-discord](https://github.com/incendo/cloud-discord) repository houses
99
- [cloud-jda5](./jda5.md): Integration for JDA5 slash commands.
1010
- [cloud-kord](./kord.md): Integration for Kord slash commands.
1111
- [cloud-javacord](./javacord.md): Integration for Javacord.
12+
13+
Example modules:
14+
15+
- [example-discord4j](https://github.com/Incendo/cloud-discord/tree/master/examples/example-discord4j): Example bot using Discord4J.
1216
- [example-jda5](https://github.com/Incendo/cloud-discord/tree/master/examples/example-jda5): Example bot using JDA5.
1317
- [example-kord](https://github.com/Incendo/cloud-discord/tree/master/examples/example-kord): Example bot using Kord.

docs/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ They are written for the Bukkit Minecraft API but the examples are not specific
2525

2626
## Structure
2727

28+
<div class="grid cards" markdown>
29+
30+
- [:material-book: Core](core/index.md)
31+
- [:fontawesome-solid-at: Annotated Commands](annotations/index.md)
32+
- [:material-language-kotlin: Kotlin Support](kotlin/index.md)
33+
- [:material-minecraft: Minecraft Integrations](minecraft/index.md)
34+
- [:simple-discord: Discord Integrations](discord/index.md)
35+
- [:material-factory: Postprocessors](https://github.com/Incendo/cloud-processors)
36+
37+
</div>
38+
2839
The documentation is split into different sections for the different Cloud modules.
2940
It is highly recommended that you get started with the [cloud-core](./core/index.md) docs before you delve into the
3041
platform-specific docs.

docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
mkdocs
22
mkdocs-material
33
mkdocs-git-revision-date-localized-plugin
4+
mkdocs-git-committers-plugin-2

mkdocs.yml

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,12 @@ theme:
6464
- content.code.copy
6565
- content.code.annotate
6666
- content.tabs.link
67+
- content.tooltips
6768
palette:
69+
- media: "(prefers-color-scheme)"
70+
toggle:
71+
icon: material/brightness-auto
72+
name: Switch to light mode
6873
- media: "(prefers-color-scheme: light)"
6974
scheme: default
7075
primary: pink
@@ -78,7 +83,7 @@ theme:
7883
accent: pink
7984
toggle:
8085
icon: material/brightness-4
81-
name: Switch to light mode
86+
name: Switch to system preference
8287
favicon: assets/images/favicon.png
8388
logo: assets/images/favicon.png
8489
markdown_extensions:
@@ -90,13 +95,22 @@ markdown_extensions:
9095
- pymdownx.superfences
9196
- pymdownx.tabbed:
9297
alternate_style: true
98+
slugify: !!python/object/apply:pymdownx.slugs.slugify
99+
kwds:
100+
case: lower
101+
- pymdownx.emoji:
102+
emoji_index: !!python/name:material.extensions.emoji.twemoji
103+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
93104
- attr_list
94105
- md_in_html
95106
plugins:
96107
- search
97108
- git-revision-date-localized:
98109
enable_creation_date: false
99110
fallback_to_build_date: true
111+
- git-committers:
112+
repository: incendo/cloud-docs
113+
branch: main
100114
extra:
101115
consent:
102116
title: Cookie consent

0 commit comments

Comments
 (0)