Click for the longer version
- 🔭 Currently building something
- 🌱 Learning something else
- 💬 Ask me about anything
- 📫 Reach me at [email protected]
- ⚡ Fun fact: ...
|
|
Note
These cards are third-party images, not GitHub features. They can be rate-limited or down. Self-host or generate static SVGs with Actions for reliability.
Note
Useful information.
Tip
Helpful advice.
Important
Key information.
Warning
Urgent info.
Caution
Risk warning.
This section is a live demo of GitHub's Markdown pipeline.1 Delete it for a clean profile.
Bold, italic, bold italic, struck, underlined, subscript, superscript, Ctrl+K, highlighted, inline code, a link, and *escaped*.
Blockquote.
Nested blockquote.
Two trailing spaces also force a break, but editors often strip them.
This line follows a two-space break.
A backslash also works.
This line follows a backslash break.
- Unordered
- Nested
- Deeper
- Nested
- Done
- Todo
- Nested done
- Starts at three
- Next
| Left | Center | Right | Inline HTML |
|---|---|---|---|
code |
bold | K | |
| link | mark | sub | sup |
| escaped pipe | a | b |
line break |
ins |
git clone https://github.com/YOUR_USERNAME/YOUR_USERNAME.gittype Greeting = { name: string };
const greet = ({ name }: Greeting) => `Hello, ${name}!`;- const old = true;
+ const shiny = true;{ "renderer": "gfm", "gradientText": "svg-only" }Inline
flowchart LR
A[Markdown] --> B{GitHub}
B -->|allowed| C[Rendered]
B -->|stripped| D[HTML / CSS / JS]
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": { "name": "Null Island" },
"geometry": {
"type": "Polygon",
"coordinates": [[[-1, 0], [1, 0], [1, 1], [-1, 1], [-1, 0]]]
}
}
]
}
solid tetra
facet normal 0 0 -1
outer loop
vertex 0 0 0
vertex 1 0 0
vertex 0 1 0
endloop
endfacet
facet normal 0 -1 0
outer loop
vertex 0 0 0
vertex 0 0 1
vertex 1 0 0
endloop
endfacet
facet normal -1 0 0
outer loop
vertex 0 0 0
vertex 0 1 0
vertex 0 0 1
endloop
endfacet
facet normal 0.577 0.577 0.577
outer loop
vertex 1 0 0
vertex 0 1 0
vertex 0 0 1
endloop
endfacet
endsolid tetra
Centered with align="center"
- Term
- Definition list via raw HTML.
Ctrl + K ·
mark ·
inserted ·
deleted ·
struck ·
quote
·
x ·
output ·
漢
| Merged | Header |
|---|---|
| A | B |
| C |
A right-aligned image wraps text. Use <br clear="all" /> if the next block needs to clear it.
Nested details
Inner
Markdown renders here because of the blank lines.
Open by default
This one starts expanded.
🚀 ✨
© — 🚀
Reference link · Collapsed · Jump to top · Relative · External · https://github.com · [email protected]
style="..."andclass="..."— stripped. No CSS, custom colors, fonts, or gradient text.<style>,<script>,<iframe>,<object>,<embed>,<form>,<input>,<button>— stripped or escaped.- Inline
<svg>— stripped. Use an SVG file through<img>. <video>— a bare<video src>can survive the sanitizer, but README playback is inconsistent;<source>children lose theirsrc, andposteris stripped. Use a GIF, animated SVG, or link.data:image/...— blocked. Host images in the repo or on HTTPS.- Protocol-relative (
//...) andftp://images — blocked. ==highlight==and^sup^— not GFM.~text~is strikethrough, not subscript. Use<mark>,<sup>,<sub>.- Color swatches like
#0969DA— work in issues/PRs/discussions, not READMEs. #123,GH-123, commit SHAs — autolink in conversations, not in README files. Use full URLs.@mentions— render, but don't rely on notifications from a README.- Alerts inside
<details>or lists — become plain blockquotes. Keep alerts top-level. - Markdown inside
<summary>— not parsed. Use<strong>/<code>. - Markdown inside
<div>/<details>— needs blank lines around it. - Tables — no block elements. Use
<br>for line breaks; raw HTML tables forrowspan/colspan. - Code fences — no line numbers, line highlighting, or filename captions.
<abbr>,<figure>,<time>,<small>,<bdo>,<center>,<font>,<u>,<big>,<cite>,<dfn>,<wbr>— stripped (some leave text behind).<img loading="lazy">,srcset,border— stripped.styleandclassare stripped everywhere.target="_blank"— stripped; links open in the same tab.relsurvives;downloadis stripped.- Profile README — no automatic Outline/TOC in the profile embed. Add your own.
- Long READMEs — the repo/profile view truncates around ~512 KB. Keep it far below.
- Uploads — 10 MB for images/GIFs; 10 MB video on free plans, 100 MB on paid; 25 MB for other files.
- External images — proxied and cached by Camo; updates can lag.
- GitHub Pages, Jekyll, VS Code preview, and other Markdown renderers — different pipelines. Test on github.com.
CSS cannot do it: style/class are stripped. Add assets/gradient.svg, then:
<img src="assets/gradient.svg" alt="YOUR NAME" width="900" />The SVG source is below. It is an image: not selectable text. Keep a real <h1> for accessibility.
Footnotes
-
GFM plus GitHub's extensions: alerts, footnotes, math, Mermaid, GeoJSON, TopoJSON, and STL. The renderer sanitizes HTML; CSS and JavaScript never run. ↩


