Skip to content

GitHub README.md

Ben Forbes Griffith edited this page Oct 11, 2023 · 2 revisions

Even though GitHub README.md files are Markdown, and although Markdown supports most HTML, you can’t put <style> or <script> tags in these files… Well, of course you could, but they will just get stripped ⽍

  • Ergo, many people assume they are quite limited in styling these documents per what Markdown will support… But is that truly the case?
  • Once extremely helpful tactic is that you can use SVG images anywhere in your README.md files as an <img src="./file.svg" alt="" />
    • When used that way, even stuff like animations within them play❕ 🤯
  • SVG has nodes like <text> for textual content, but also <foreignObject> for HTML content…
  • SVG also supports <style> tags.
  • awesome GitHub profile README.md examples