Skip to content

Commit

Permalink
feat: enable new mkdocs-material features
Browse files Browse the repository at this point in the history
  • Loading branch information
Citymonstret committed Jan 21, 2024
1 parent 2337d22 commit a8abba7
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,8 @@ Subcommands
kord
Kord
Kord's
Integrations
fontawesome
github
https
md
4 changes: 4 additions & 0 deletions docs/discord/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,9 @@ The [cloud-discord](https://github.com/incendo/cloud-discord) repository houses
- [cloud-jda5](./jda5.md): Integration for JDA5 slash commands.
- [cloud-kord](./kord.md): Integration for Kord slash commands.
- [cloud-javacord](./javacord.md): Integration for Javacord.

Example modules:

- [example-discord4j](https://github.com/Incendo/cloud-discord/tree/master/examples/example-discord4j): Example bot using Discord4J.
- [example-jda5](https://github.com/Incendo/cloud-discord/tree/master/examples/example-jda5): Example bot using JDA5.
- [example-kord](https://github.com/Incendo/cloud-discord/tree/master/examples/example-kord): Example bot using Kord.
11 changes: 11 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,17 @@ They are written for the Bukkit Minecraft API but the examples are not specific

## Structure

<div class="grid cards" markdown>

- [:material-book: Core](core/index.md)
- [:fontawesome-solid-at: Annotated Commands](annotations/index.md)
- [:material-language-kotlin: Kotlin Support](kotlin/index.md)
- [:material-minecraft: Minecraft Integrations](minecraft/index.md)
- [:simple-discord: Discord Integrations](discord/index.md)
- [:material-factory: Postprocessors](https://github.com/Incendo/cloud-processors)

</div>

The documentation is split into different sections for the different Cloud modules.
It is highly recommended that you get started with the [cloud-core](./core/index.md) docs before you delve into the
platform-specific docs.
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
mkdocs
mkdocs-material
mkdocs-git-revision-date-localized-plugin
mkdocs-git-committers-plugin-2
16 changes: 15 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,12 @@ theme:
- content.code.copy
- content.code.annotate
- content.tabs.link
- content.tooltips
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: pink
Expand All @@ -78,7 +83,7 @@ theme:
accent: pink
toggle:
icon: material/brightness-4
name: Switch to light mode
name: Switch to system preference
favicon: assets/images/favicon.png
logo: assets/images/favicon.png
markdown_extensions:
Expand All @@ -90,13 +95,22 @@ markdown_extensions:
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- attr_list
- md_in_html
plugins:
- search
- git-revision-date-localized:
enable_creation_date: false
fallback_to_build_date: true
- git-committers:
repository: incendo/cloud-docs
branch: main
extra:
consent:
title: Cookie consent
Expand Down

0 comments on commit a8abba7

Please sign in to comment.