From 6900f7f43cf02215b2c75572980ac875207a02a5 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 12:42:39 -0400 Subject: [PATCH] Add info about custom icons to meta --- docs/handbook/meta/.nav.yml | 3 ++- docs/handbook/meta/custom_icons.md | 25 +++++++++++++++++++++++++ 2 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 docs/handbook/meta/custom_icons.md diff --git a/docs/handbook/meta/.nav.yml b/docs/handbook/meta/.nav.yml index 9d27d6d..d21ca40 100644 --- a/docs/handbook/meta/.nav.yml +++ b/docs/handbook/meta/.nav.yml @@ -2,4 +2,5 @@ title: Meta nav: - index.md - editing.md - - syntax.md \ No newline at end of file + - syntax.md + - custom_icons.md \ No newline at end of file diff --git a/docs/handbook/meta/custom_icons.md b/docs/handbook/meta/custom_icons.md new file mode 100644 index 0000000..4b2c843 --- /dev/null +++ b/docs/handbook/meta/custom_icons.md @@ -0,0 +1,25 @@ +# Custom Icons +Material for MkDocs supports custom icons (for example, for our product logos). Here are some notes and steps on adding these files to this site. + +## 0. Start with an svg +You will need the icon in a square `.svg` file format, with a transparent background. I haven't experimented too much with size, but files up to 1000 x 1000 seem to work fine so far. + +## 1. Minify the svg +So that the image will work with MkDocs' color switching and CSS, we need to remove any embedded colors and cruft from the SVG file. + +1. Open [:octicons-link-external-16: SVGOMG Optimize](https://optimize.svgomg.net/) +2. In the left menu, choose **Open SVG** and upload your SVG file +3. In the *Global Settings* menu, turn on all the options **except for** `Show original`. Leave the sliders at their default settings. +4. In the *Features* menu, turn on all the options **except for** `Remove xmlns`. +5. Use the blue download button to download your newly optimized SVG. + +## 2. Add the optimized svg to this repo +In the `about` repo, add the optimized svg file you just downloaded to the `overrides\.icons\` folder. The category will depend on what kind of icon you're adding. (StarCat product icons go in `logos`, etc.) + +## 3. Use your new icon +If you're using the new icon in a Markdown page, you can use the syntax `-`. So, if the category is `logos` and the icon is `docshub.svg`, your icon syntax would be `icons-docshub`. + +## Reference +For a list of the major custom icons and their syntax, see [:octicons-arrow-right-16: Syntax #Custom Icons](syntax.md#custom-icons). + +For the primary documentation on Custom Icons in Material for MkDocs, see [:simple-materialformkdocs: Customization - Additional icons](https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#additional-icons). \ No newline at end of file