From 751d3515eeeb8f25ddc597a9d75d5c7be4929b45 Mon Sep 17 00:00:00 2001 From: Adam Iannazzone <46025473+jiannazzone@users.noreply.github.com> Date: Sun, 18 Aug 2024 11:22:29 -0400 Subject: [PATCH] Add custom emoji/icon support - Enable plugin in mkdocs.yml - Add example icon to folder structure --- wiki-rtd/mkdocs.yml | 50 +++++++++++-------- wiki-rtd/overrides/.icons/brands/nintendo.svg | 1 + 2 files changed, 30 insertions(+), 21 deletions(-) create mode 100644 wiki-rtd/overrides/.icons/brands/nintendo.svg diff --git a/wiki-rtd/mkdocs.yml b/wiki-rtd/mkdocs.yml index 276c35d..003914f 100644 --- a/wiki-rtd/mkdocs.yml +++ b/wiki-rtd/mkdocs.yml @@ -8,7 +8,7 @@ copyright: "© 2024 RetroDECK Team" # Theme Configuration theme: - name: "material" + name: material language: "en" logo: wiki_icons/retrodeck/rd_icon_circle_32x32.png features: @@ -20,39 +20,47 @@ theme: accent: "white" extra_css: - stylesheets/extra.css + custom_dir: overrides + markdown_extensions: - pymdownx.highlight: anchor_linenums: true pygments_lang_class: true + +# Used to create custom emoji/icons using .svg files. See link for usage information +# https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#additional-icons + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + options: + custom_icons: + - overrides/.icons - pymdownx.superfences - attr_list plugins: - - search: - - mkdocs-video: - is_video: True -# video_muted: True - video_controls: True -# css_style: -# width: "50%" - - rss: + - search + - mkdocs-video: + is_video: True + video_controls: True + - rss: match_path: blog/posts/.* date_from_meta: as_creation: date categories: - categories - tags - - blog: - enabled: true - post_url_date_format: yyyy/MM/dd - post_date_format: full - blog_toc: true - archive: true - archive_date_format: yyyy - pagination: false - pagination: false - post_excerpt: required - post_excerpt_separator: + - blog: + enabled: true + post_url_date_format: yyyy/MM/dd + post_date_format: full + blog_toc: true + archive: true + archive_date_format: yyyy + pagination: false + pagination: false + post_excerpt: required + post_excerpt_separator: # Sidebar Navigation @@ -253,7 +261,7 @@ nav: - Singstar - Microphone (WIP): wiki_controllers/music/singstar-microphone.md - Taiko Drum & Bachi (WIP): wiki_controllers/music/taiko-drum-bachi.md - - Nintendo 🎮: + - Nintendo: - Switch - Joy-Cons (WIP): wiki_controllers/nintendo/joycon.md - Switch - Ring Fit (WIP): wiki_controllers/nintendo/ring-fit.md - Wii U - Gamepad: wiki_controllers/nintendo/wiiu-gamepad.md diff --git a/wiki-rtd/overrides/.icons/brands/nintendo.svg b/wiki-rtd/overrides/.icons/brands/nintendo.svg new file mode 100644 index 0000000..5cad964 --- /dev/null +++ b/wiki-rtd/overrides/.icons/brands/nintendo.svg @@ -0,0 +1 @@ +Nintendo \ No newline at end of file