Skip to content
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

add inline icon role and doc for it #182

Merged
merged 6 commits into from
Nov 3, 2022
Merged

add inline icon role and doc for it #182

merged 6 commits into from
Nov 3, 2022

Conversation

2bndy5
Copy link
Collaborator

@2bndy5 2bndy5 commented Nov 1, 2022

Add ability to use a builtin icon or a project specific SVG (located in static folder) as an inline text element.

- :md-icon:`octicons/mark-github-16` `Octicons <https://octicons.github.com/>`_
- :md-icon:`simple/simpleicons` `Simple Icons <https://simpleicons.org/>`_

You can also browse these icons locally from the sphinx-immaterial theme's install path under
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose we could integrate the "icon" index from mkdocs-material into our docs...

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I thought about that too. This is something that can be addressed in the next merge from upstream, assuming we currently exclude the part of the build script that creates the json.

@2bndy5 2bndy5 force-pushed the inline-icons branch 2 times, most recently from e7f1b98 to fb238d6 Compare November 1, 2022 21:33
@jbms
Copy link
Owner

jbms commented Nov 3, 2022

Looks good to me.

@2bndy5 2bndy5 merged commit 09b41f9 into main Nov 3, 2022
@2bndy5 2bndy5 deleted the inline-icons branch November 3, 2022 02:36
@2bndy5 2bndy5 mentioned this pull request Nov 3, 2022
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

Successfully merging this pull request may close these issues.

2 participants