From bf74be37a7ef60af7a86d0689dc5a0c8b7341f2e Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 12:42:22 -0400 Subject: [PATCH 1/4] Add StarCat logo icons --- overrides/.icons/logos/docshub.svg | 4 ++++ overrides/.icons/logos/openhosted.svg | 3 +++ overrides/.icons/logos/postline.svg | 3 +++ overrides/.icons/logos/sourcecamp.svg | 3 +++ overrides/.icons/logos/stagelink.svg | 4 ++++ overrides/.icons/logos/starcat-circle.svg | 4 ++++ 6 files changed, 21 insertions(+) create mode 100644 overrides/.icons/logos/docshub.svg create mode 100644 overrides/.icons/logos/openhosted.svg create mode 100644 overrides/.icons/logos/postline.svg create mode 100644 overrides/.icons/logos/sourcecamp.svg create mode 100644 overrides/.icons/logos/stagelink.svg create mode 100644 overrides/.icons/logos/starcat-circle.svg diff --git a/overrides/.icons/logos/docshub.svg b/overrides/.icons/logos/docshub.svg new file mode 100644 index 0000000..988adca --- /dev/null +++ b/overrides/.icons/logos/docshub.svg @@ -0,0 +1,4 @@ + + + + diff --git a/overrides/.icons/logos/openhosted.svg b/overrides/.icons/logos/openhosted.svg new file mode 100644 index 0000000..92a8b0a --- /dev/null +++ b/overrides/.icons/logos/openhosted.svg @@ -0,0 +1,3 @@ + + + diff --git a/overrides/.icons/logos/postline.svg b/overrides/.icons/logos/postline.svg new file mode 100644 index 0000000..0d59b13 --- /dev/null +++ b/overrides/.icons/logos/postline.svg @@ -0,0 +1,3 @@ + + + diff --git a/overrides/.icons/logos/sourcecamp.svg b/overrides/.icons/logos/sourcecamp.svg new file mode 100644 index 0000000..2ce6244 --- /dev/null +++ b/overrides/.icons/logos/sourcecamp.svg @@ -0,0 +1,3 @@ + + + diff --git a/overrides/.icons/logos/stagelink.svg b/overrides/.icons/logos/stagelink.svg new file mode 100644 index 0000000..b490393 --- /dev/null +++ b/overrides/.icons/logos/stagelink.svg @@ -0,0 +1,4 @@ + + + + diff --git a/overrides/.icons/logos/starcat-circle.svg b/overrides/.icons/logos/starcat-circle.svg new file mode 100644 index 0000000..569d2b8 --- /dev/null +++ b/overrides/.icons/logos/starcat-circle.svg @@ -0,0 +1,4 @@ + + + + From 6900f7f43cf02215b2c75572980ac875207a02a5 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 12:42:39 -0400 Subject: [PATCH 2/4] 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 From 633688236305663a4762a4a2de9bce402ae936d2 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 12:43:07 -0400 Subject: [PATCH 3/4] Add custom icons to syntax info --- docs/handbook/meta/syntax.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/handbook/meta/syntax.md b/docs/handbook/meta/syntax.md index 36ab0e9..4450110 100644 --- a/docs/handbook/meta/syntax.md +++ b/docs/handbook/meta/syntax.md @@ -12,6 +12,17 @@ Reference for all available Material for MkDocs icons: [:simple-materialformkdoc :material-book-lock: `:material-book-lock:` - used for links to the StarCat Systems internal handbook :material-folder-lock: `:material-folder-lock:` - used for restricted links to files hosted on StarCat Cloud. +### Custom icons +There are some custom icons added to this MkDocs instance, for example for StarCat product logos. See [:octicons-arrow-right-16: Custom Icons](custom_icons.md) for more details on adding and using custom icons. + +#### Logos +:logos-starcat-circle: `:logos-starcat-circle:` - StarCat Systems circle logo +:logos-sourcecamp: `:logos-sourcecamp:` - SourceCamp logo +:logos-docshub: `:logos-docshub:` - DocsHub logo +:logos-stagelink: `:logos-stagelink:` - StageLink logo +:logos-postline: `:logos-postline:` - PostLine logo +:logos-openhosted: `:logos-openhosted:` - OpenHosted logo + ### Coloring icons You can add a color to an icon by adding the CSS color after the icon, like this: :fontawesome-solid-dragon:{ .bug-pink } `:fontawesome-solid-dragon:{ .bug-pink }` From 5b4a0a884555fc29340a9c6bb9fcfc46ab9851e6 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 12:43:20 -0400 Subject: [PATCH 4/4] Add PostLine and OpenHosted logo attribution --- docs/about/attribution.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/about/attribution.md b/docs/about/attribution.md index b647811..6655495 100644 --- a/docs/about/attribution.md +++ b/docs/about/attribution.md @@ -12,6 +12,8 @@ This site, and all StarCat Systems projects, products, and services make use of - [SourceCamp](https://source.camp) logo - adapted from [camp](https://thenounproject.com/icon/camp-7375488/) by [Ricons](https://thenounproject.com/creator/ricons/) from Noun Project. - [DocsHub](https://docshub.io) logo - adapted from [Document](https://thenounproject.com/icon/document-6244658/) by [Reion](https://thenounproject.com/creator/dickydante/) from Noun Project. - [StageLink](https://stagelink.cloud) logo - adapted from [slider](https://thenounproject.com/icon/slider-2309209/) by [DinosoftLabs](https://thenounproject.com/creator/dinosoftlab/) from Noun Project. +- [PostLine](https://postline.email) logo - adapted from [Group Mail](https://thenounproject.com/icon/group-mail-1571732/) by [Smashicons](https://thenounproject.com/creator/smashicons/) from Noun Project. +- [OpenHosted](https://openhosted.net) logo - adapted from [Blockchain](https://thenounproject.com/icon/blockchain-7881143/) by [Hermanto](https://thenounproject.com/creator/kak.her1992/) from Noun Project. ## Images