Skip to content

Custom SVG as icon prop in sidebar nav #545

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lifeinchords opened this issue Feb 25, 2025 · 2 comments
Open

Custom SVG as icon prop in sidebar nav #545

lifeinchords opened this issue Feb 25, 2025 · 2 comments

Comments

@lifeinchords
Copy link

Hi there,

I love Mintlify!

I'm trying to add the OpenAI logo as a nav bar item icon.
I think Font Awesome are still working on adding it to the library, so wanted to add the SVG myself.

Are custom SVG icons in the nav supported?

I see a SVG icon via a card prop docs/integrations/analytics.mdx as described in the docs,
but couldn't find any examples for inserting it into the nav via the mdx header like:

---
title: 'Open AI'
description: ''
icon: "<svg><path d='M11.9442 13.2715L4.12777 2.06738L1.26172 15.095L11.9442 13.2715Z'
    stroke='#888888'/></svg>"
---
# test SVG path, not the actual logo SVG ^

The wierd part is when I try this, I see some SVG in the DOM but it renders as a square like this:

Image

I thought maybe the SVG I'm using is bad, so tried a very simple path instead.
This is the rendered el:

<svg class="h-4 w-4 bg-primary dark:bg-primary-light" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/{<svg><path d='M11.9442 13.2715L4.12777 2.06738L1.26172 15.095L11.9442 13.2715Z' stroke='#888888'/></svg>}.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/{<svg><path d='M11.9442 13.2715L4.12777 2.06738L1.26172 15.095L11.9442 13.2715Z' stroke='#888888'/></svg>}.svg);mask-repeat:no-repeat;mask-position:center"></svg>

Lastly, I found global settings to change the font library, but I'm not sure how to use it
https://mintlify.com/docs/settings/global#param-icons
I'm using FA everywhere else in my docs, and would prefer not to switch to another font lib.

Am I missing anything?

@MQ37
Copy link

MQ37 commented Mar 21, 2025

@lifeinchords
Hey, when writing integration docs for Apify and wanting to include our own logo, which is not part of Font Awesome, I used this CSS trick. You can link any image you want unless it is blocked by CORS: in order to bypass CORS, I had to upload the image to Wikimedia. But if it's your site, you can easily skip this step and serve the image yourself.

See how to use a custom icon in the sidebar:
https://github.com/MQ37/crewAI/blob/d614f0a4940947a89cf8ccf1f16d0e5ec8b33912/docs/tools/apifyactorstool.mdx?plain=1#L5

How it looks on the page:
https://docs.crewai.com/tools/apifyactorstool

@lifeinchords
Copy link
Author

hey @MQ37,
Ah, I figured there must be a way,
Thanks for the tip and the link to the source, this is perfect!

🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants