December 23rd, 2020
Even though GitHub Readme files (typically
./readme.md) are Markdown, and although Markdown supports HTML, you can’t put
<script> tags init. (Well, you can, they just get stripped.) So you can’t apply custom styles there. Or can you?
- You can use SVG as an
<img src="./file.svg" alt="" />(anywhere).
- When used that way, even stuff like animations within them play (wow).
- SVG has stuff like
<text>for textual content, but also
<foreignObject>for regular ol’ HTML content.
- SVG support
readme.mdfile does support
<img>with SVG sources.
Sindre Sorhus combined all that into an example.
That same SVG source will work here:
The original post Custom Styles in GitHub Readme Files.