📝 Update link syntax to minimal Markdown - #1800

Merged
tiangolo merged 3 commits into
mainfrom
no-blank
May 18, 2026
Merged

📝 Update link syntax to minimal Markdown#1800
tiangolo merged 3 commits into
mainfrom
no-blank

Conversation

@tiangolo

@tiangolotiangolo commented Mar 5, 2026•
edited
Loading

Copy link
Copy Markdown
Member

📝 Update link syntax to minimal Markdown

No longer use the classes external-link and internal-link, remove target=_blank, which is now added automatically by JS, and move from HTML to Markdown syntax (as now it no longer needs anything from HTML).

The migration was done automatically with this script, generated with Claude Opus 4.6, the results were reviewed by (human) hand one by one.

Copied from fastapi/fastapi#15061

#!/usr/bin/env python3"""Remove .external-link and .internal-link classes and target=_blank from docs,converting HTML <a> tags to Markdown links where possible.Handles these patterns:1. HTML external/internal links (simple text content): <a href="URL" class="external-link" target="_blank">Text</a> → [Text](URL)2. HTML links with <strong> content: <a href="URL" class="external-link" target="_blank"><strong>Text</strong></a> → [**Text**](URL)3. HTML links with <code> content: <a href="URL" class="external-link" target="_blank"><code>text</code></a> → [`text`](URL)4. HTML links with <abbr> (converted, abbr kept inline): <a href="URL" class="external-link" target="_blank"><abbr title="T">Text</abbr></a> → [<abbr title="T">Text</abbr>](URL)5. HTML links with mixed <abbr> + <code>/<strong> (converted): <a href="URL" class="external-link" target="_blank"><abbr>X</abbr> docs for <code>POST</code></a> → [<abbr>X</abbr> docs for `POST`](URL)6. Markdown attr_list (.internal-link or .external-link and target=_blank removed): [Text](URL){.internal-link target=_blank} → [Text](URL)7. HTML <a> tags without link classes but with target="_blank" (class stripped, target removed): <a href="URL" target="_blank">Text</a> → [Text](URL)8. Markdown attr_list with only target=_blank (removed): [Text](URL){target=_blank} → [Text](URL)"""importreimportsysfrompathlibimportPathdefconvert_html_link_to_markdown(match: str) ->str:
"""Convert <a> tag to markdown link, stripping class and target."""# Extract hrefhref_m=re.search(r'href="([^"]*)"', match)
ifnothref_m:
returnmatchhref=href_m.group(1)
# Extract inner content (between > and </a>)content_m=re.search(r'>(.+?)</a>\s*$', match, re.DOTALL)
ifnotcontent_m:
returnmatchcontent=content_m.group(1).strip()
# Convert inline HTML to markdown equivalents# Convert <strong>text</strong> → **text**content=re.sub(r'<strong>(.*?)</strong>', r'**\1**', content)
# Convert <code>text</code> → `text`content=re.sub(r'<code>(.*?)</code>', r'`\1`', content)
# Convert <em>text</em> → *text*content=re.sub(r'<em>(.*?)</em>', r'*\1*', content)
# If there's still HTML other than <abbr> in the content, keep as HTML# but remove class and target attributescontent_without_abbr=re.sub(r'<abbr\s[^>]*>.*?</abbr>', '', content)
if'<'incontent_without_abbr:
result=re.sub(r'\s*class="(?:external|internal)-link"', '', match)
result=re.sub(r'\s*target="[^"]*"', '', result)
returnresultreturnf"[{content}]({href})"defprocess_file(filepath: Path, dry_run: bool=False) ->tuple[int, list[str]]:
"""Process a single file. Returns (change_count, list of changes)."""text=filepath.read_text(encoding="utf-8")
original=textchanges: list[str] = []
# Pattern 1: HTML <a> tags with class="external-link" or class="internal-link"# Handles attributes in any orderhtml_class_pattern=re.compile(
r'<a\s+'r'(?=[^>]*class="(?:external|internal)-link")'# must have the classr'[^>]*?'# other attrs before hrefr'href="[^"]*"'# hrefr'[^>]*?'# other attrsr'>'# end of opening tagr'.+?'# contentr'</a>', # closing tagre.DOTALL,
)
defreplace_html_class(m: re.Match) ->str:
result=convert_html_link_to_markdown(m.group(0))
ifresult!=m.group(0):
changes.append(f" HTML class → MD: {m.group(0)[:80]}...")
returnresulttext=html_class_pattern.sub(replace_html_class, text)
# Pattern 2: HTML <a> tags with target="_blank" but no link class# (these may have been left by previous runs or were never classed)html_target_pattern=re.compile(
r'<a\s+'r'(?=[^>]*target="_blank")'# must have target=_blankr'(?![^>]*class=")'# must NOT have a class attrr'[^>]*?'# other attrs before hrefr'href="[^"]*"'# hrefr'[^>]*?'# other attrsr'>'# end of opening tagr'.+?'# contentr'</a>', # closing tagre.DOTALL,
)
defreplace_html_target(m: re.Match) ->str:
result=convert_html_link_to_markdown(m.group(0))
ifresult!=m.group(0):
changes.append(f" HTML target → MD: {m.group(0)[:80]}...")
returnresulttext=html_target_pattern.sub(replace_html_target, text)
# Pattern 3: Markdown attr_list with .external-link or .internal-link# [Text](URL){.internal-link target=_blank} → [Text](URL)# [Text](URL){.external-link target=_blank} → [Text](URL)md_class_pattern=re.compile(
r'(\[[^\]]+\]\([^)]+\))'# [text](url)r'\{'# {r'\.(?:external|internal)-link'# .external-link or .internal-linkr'\s*'# optional spacer'([^}]*?)'# remaining attrs (e.g. target=_blank)r'\}'# }
)
defreplace_md_class(m: re.Match) ->str:
link_part=m.group(1)
remaining_attrs=m.group(2).strip()
# Remove target=_blank from remaining attrsremaining_attrs=re.sub(r'target=_blank\s*', '', remaining_attrs).strip()
ifremaining_attrs:
result=f"{link_part}{{{remaining_attrs}}}"else:
result=link_partchanges.append(f" MD class attr: {m.group(0)[:80]}...")
returnresulttext=md_class_pattern.sub(replace_md_class, text)
# Pattern 4: Markdown attr_list with only target=_blank (no class)# [Text](URL){target=_blank} → [Text](URL)md_target_pattern=re.compile(
r'(\[[^\]]+\]\([^)]+\))'# [text](url)r'\{target=_blank\}'# {target=_blank}
)
defreplace_md_target(m: re.Match) ->str:
changes.append(f" MD target attr: {m.group(0)[:80]}...")
returnm.group(1)
text=md_target_pattern.sub(replace_md_target, text)
iftext!=original:
ifnotdry_run:
filepath.write_text(text, encoding="utf-8")
returnlen(changes), changesreturn0, []
defmain() ->None:
dry_run="--dry-run"insys.argvdocs_dir=Path("docs")
ifnotdocs_dir.exists():
print(f"Error: {docs_dir} not found. Run from the repo root.")
sys.exit(1)
total_changes=0files_changed=0formd_fileinsorted(docs_dir.rglob("*.md")):
count, changes=process_file(md_file, dry_run=dry_run)
ifcount:
files_changed+=1total_changes+=countprint(f"{md_file} ({count} changes)")
forcinchanges:
print(c)
mode="DRY RUN"ifdry_runelse"APPLIED"print(f"\n{mode}: {total_changes} changes across {files_changed} files")
if__name__=="__main__":
main()

@github-actionsgithub-actionsBot added the docs Improvements or additions to documentation label Mar 5, 2026
@github-actions

github-actionsBot commented Mar 5, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor

📝 Docs preview

Last commit 21e4f38 at: https://2ebc30aa.sqlmodel.pages.dev

Modified Pages

@github-actionsgithub-actionsBot added the conflicts Automatically generated when a PR has a merge conflict label May 18, 2026
@github-actions

github-actionsBot commented May 18, 2026

Copy link
Copy Markdown
Contributor

This pull request has a merge conflict that needs to be resolved.

@github-actionsgithub-actionsBot removed the conflicts Automatically generated when a PR has a merge conflict label May 18, 2026
@tiangolo
tiangolo merged commit be45a56 into mainMay 18, 2026
28 checks passed
@tiangolo
tiangolo deleted the no-blank branch May 18, 2026 12:15
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

docsImprovements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@tiangolo
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
📝 Update link syntax to minimal Markdown - #1800
Merged
tiangolo merged 3 commits into
mainfrom 
no-blank
May 18, 2026
Merged
📝 Update link syntax to minimal Markdown#1800
tiangolo merged 3 commits into
mainfrom 
no-blank
Conversation
@tiangolo
@tiangolotiangolo
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

Member
📝 Update link syntax to minimal Markdown
No longer use the classes external-link and internal-link, remove target=_blank, which is now added automatically by JS, and move from HTML to Markdown syntax (as now it no longer needs anything from HTML).
The migration was done automatically with this script, generated with Claude Opus 4.6, the results were reviewed by (human) hand one by one.
Copied from fastapi/fastapi#15061
#!/usr/bin/env python3"""Remove .external-link and .internal-link classes and target=_blank from docs,converting HTML <a> tags to Markdown links where possible.Handles these patterns:1. HTML external/internal links (simple text content): <a href="URL" class="external-link" target="_blank">Text</a> → [Text](URL)2. HTML links with <strong> content: <a href="URL" class="external-link" target="_blank"><strong>Text</strong></a> → [**Text**](URL)3. HTML links with <code> content: <a href="URL" class="external-link" target="_blank"><code>text</code></a> → [`text`](URL)4. HTML links with <abbr> (converted, abbr kept inline): <a href="URL" class="external-link" target="_blank"><abbr title="T">Text</abbr></a> → [<abbr title="T">Text</abbr>](URL)5. HTML links with mixed <abbr> + <code>/<strong> (converted): <a href="URL" class="external-link" target="_blank"><abbr>X</abbr> docs for <code>POST</code></a> → [<abbr>X</abbr> docs for `POST`](URL)6. Markdown attr_list (.internal-link or .external-link and target=_blank removed): [Text](URL){.internal-link target=_blank} → [Text](URL)7. HTML <a> tags without link classes but with target="_blank" (class stripped, target removed): <a href="URL" target="_blank">Text</a> → [Text](URL)8. Markdown attr_list with only target=_blank (removed): [Text](URL){target=_blank} → [Text](URL)"""importreimportsysfrompathlibimportPathdefconvert_html_link_to_markdown(match: str) ->str:
"""Convert <a> tag to markdown link, stripping class and target."""# Extract hrefhref_m=re.search(r'href="([^"]*)"', match)
ifnothref_m:
returnmatchhref=href_m.group(1)
# Extract inner content (between > and </a>)content_m=re.search(r'>(.+?)</a>\s*$', match, re.DOTALL)
ifnotcontent_m:
returnmatchcontent=content_m.group(1).strip()
# Convert inline HTML to markdown equivalents# Convert <strong>text</strong> → **text**content=re.sub(r'<strong>(.*?)</strong>', r'**\1**', content)
# Convert <code>text</code> → `text`content=re.sub(r'<code>(.*?)</code>', r'`\1`', content)
# Convert <em>text</em> → *text*content=re.sub(r'<em>(.*?)</em>', r'*\1*', content)
# If there's still HTML other than <abbr> in the content, keep as HTML# but remove class and target attributescontent_without_abbr=re.sub(r'<abbr\s[^>]*>.*?</abbr>', '', content)
if'<'incontent_without_abbr:
result=re.sub(r'\s*class="(?:external|internal)-link"', '', match)
result=re.sub(r'\s*target="[^"]*"', '', result)
returnresultreturnf"[{content}]({href})"defprocess_file(filepath: Path, dry_run: bool=False) ->tuple[int, list[str]]:
"""Process a single file. Returns (change_count, list of changes)."""text=filepath.read_text(encoding="utf-8")
original=textchanges: list[str] = []
# Pattern 1: HTML <a> tags with class="external-link" or class="internal-link"# Handles attributes in any orderhtml_class_pattern=re.compile(
r'<a\s+'r'(?=[^>]*class="(?:external|internal)-link")'# must have the classr'[^>]*?'# other attrs before hrefr'href="[^"]*"'# hrefr'[^>]*?'# other attrsr'>'# end of opening tagr'.+?'# contentr'</a>', # closing tagre.DOTALL,
)
defreplace_html_class(m: re.Match) ->str:
result=convert_html_link_to_markdown(m.group(0))
ifresult!=m.group(0):
changes.append(f" HTML class → MD: {m.group(0)[:80]}...")
returnresulttext=html_class_pattern.sub(replace_html_class, text)
# Pattern 2: HTML <a> tags with target="_blank" but no link class# (these may have been left by previous runs or were never classed)html_target_pattern=re.compile(
r'<a\s+'r'(?=[^>]*target="_blank")'# must have target=_blankr'(?![^>]*class=")'# must NOT have a class attrr'[^>]*?'# other attrs before hrefr'href="[^"]*"'# hrefr'[^>]*?'# other attrsr'>'# end of opening tagr'.+?'# contentr'</a>', # closing tagre.DOTALL,
)
defreplace_html_target(m: re.Match) ->str:
result=convert_html_link_to_markdown(m.group(0))
ifresult!=m.group(0):
changes.append(f" HTML target → MD: {m.group(0)[:80]}...")
returnresulttext=html_target_pattern.sub(replace_html_target, text)
# Pattern 3: Markdown attr_list with .external-link or .internal-link# [Text](URL){.internal-link target=_blank} → [Text](URL)# [Text](URL){.external-link target=_blank} → [Text](URL)md_class_pattern=re.compile(
r'(\[[^\]]+\]\([^)]+\))'# [text](url)r'\{'# {r'\.(?:external|internal)-link'# .external-link or .internal-linkr'\s*'# optional spacer'([^}]*?)'# remaining attrs (e.g. target=_blank)r'\}'# }
)
defreplace_md_class(m: re.Match) ->str:
link_part=m.group(1)
remaining_attrs=m.group(2).strip()
# Remove target=_blank from remaining attrsremaining_attrs=re.sub(r'target=_blank\s*', '', remaining_attrs).strip()
ifremaining_attrs:
result=f"{link_part}{{{remaining_attrs}}}"else:
result=link_partchanges.append(f" MD class attr: {m.group(0)[:80]}...")
returnresulttext=md_class_pattern.sub(replace_md_class, text)
# Pattern 4: Markdown attr_list with only target=_blank (no class)# [Text](URL){target=_blank} → [Text](URL)md_target_pattern=re.compile(
r'(\[[^\]]+\]\([^)]+\))'# [text](url)r'\{target=_blank\}'# {target=_blank}
)
defreplace_md_target(m: re.Match) ->str:
changes.append(f" MD target attr: {m.group(0)[:80]}...")
returnm.group(1)
text=md_target_pattern.sub(replace_md_target, text)
iftext!=original:
ifnotdry_run:
filepath.write_text(text, encoding="utf-8")
returnlen(changes), changesreturn0, []
defmain() ->None:
dry_run="--dry-run"insys.argvdocs_dir=Path("docs")
ifnotdocs_dir.exists():
print(f"Error: {docs_dir} not found. Run from the repo root.")
sys.exit(1)
total_changes=0files_changed=0formd_fileinsorted(docs_dir.rglob("*.md")):
count, changes=process_file(md_file, dry_run=dry_run)
ifcount:
files_changed+=1total_changes+=countprint(f"{md_file} ({count} changes)")
forcinchanges:
print(c)
mode="DRY RUN"ifdry_runelse"APPLIED"print(f"\n{mode}: {total_changes} changes across {files_changed} files")
if__name__=="__main__":
main()
@github-actionsgithub-actionsBot
added
the 
docs
Improvements or additions to documentation
label
Mar 5, 2026
@github-actions
github-actionsBot
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
📝 Docs preview
Last commit 21e4f38 at: https://2ebc30aa.sqlmodel.pages.dev
Modified Pages
@github-actionsgithub-actionsBot
added
the 
conflicts
Automatically generated when a PR has a merge conflict
label
May 18, 2026
@github-actions
github-actionsBot
commented
May 18, 2026

Copy link


Copy Markdown

Contributor
This pull request has a merge conflict that needs to be resolved.
@github-actionsgithub-actionsBot
removed
the 
conflicts
Automatically generated when a PR has a merge conflict
label
May 18, 2026
@tiangolo
tiangolo
merged commit be45a56
into
mainMay 18, 2026

28 checks passed

@tiangolo
tiangolo
deleted the

no-blank

branch
May 18, 2026 12:15
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels

docsImprovements or additions to documentation

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@tiangolo

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
📝 Update link syntax to minimal Markdown - #1800
Merged
tiangolo merged 3 commits into
mainfrom 
no-blank
May 18, 2026
Merged
📝 Update link syntax to minimal Markdown#1800
tiangolo merged 3 commits into
mainfrom 
no-blank
Conversation
@tiangolo
@tiangolotiangolo
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

Member
📝 Update link syntax to minimal Markdown
No longer use the classes external-link and internal-link, remove target=_blank, which is now added automatically by JS, and move from HTML to Markdown syntax (as now it no longer needs anything from HTML).
The migration was done automatically with this script, generated with Claude Opus 4.6, the results were reviewed by (human) hand one by one.
Copied from fastapi/fastapi#15061
#!/usr/bin/env python3"""Remove .external-link and .internal-link classes and target=_blank from docs,converting HTML <a> tags to Markdown links where possible.Handles these patterns:1. HTML external/internal links (simple text content): <a href="URL" class="external-link" target="_blank">Text</a> → [Text](URL)2. HTML links with <strong> content: <a href="URL" class="external-link" target="_blank"><strong>Text</strong></a> → [**Text**](URL)3. HTML links with <code> content: <a href="URL" class="external-link" target="_blank"><code>text</code></a> → [`text`](URL)4. HTML links with <abbr> (converted, abbr kept inline): <a href="URL" class="external-link" target="_blank"><abbr title="T">Text</abbr></a> → [<abbr title="T">Text</abbr>](URL)5. HTML links with mixed <abbr> + <code>/<strong> (converted): <a href="URL" class="external-link" target="_blank"><abbr>X</abbr> docs for <code>POST</code></a> → [<abbr>X</abbr> docs for `POST`](URL)6. Markdown attr_list (.internal-link or .external-link and target=_blank removed): [Text](URL){.internal-link target=_blank} → [Text](URL)7. HTML <a> tags without link classes but with target="_blank" (class stripped, target removed): <a href="URL" target="_blank">Text</a> → [Text](URL)8. Markdown attr_list with only target=_blank (removed): [Text](URL){target=_blank} → [Text](URL)"""importreimportsysfrompathlibimportPathdefconvert_html_link_to_markdown(match: str) ->str:
"""Convert <a> tag to markdown link, stripping class and target."""# Extract hrefhref_m=re.search(r'href="([^"]*)"', match)
ifnothref_m:
returnmatchhref=href_m.group(1)
# Extract inner content (between > and </a>)content_m=re.search(r'>(.+?)</a>\s*$', match, re.DOTALL)
ifnotcontent_m:
returnmatchcontent=content_m.group(1).strip()
# Convert inline HTML to markdown equivalents# Convert <strong>text</strong> → **text**content=re.sub(r'<strong>(.*?)</strong>', r'**\1**', content)
# Convert <code>text</code> → `text`content=re.sub(r'<code>(.*?)</code>', r'`\1`', content)
# Convert <em>text</em> → *text*content=re.sub(r'<em>(.*?)</em>', r'*\1*', content)
# If there's still HTML other than <abbr> in the content, keep as HTML# but remove class and target attributescontent_without_abbr=re.sub(r'<abbr\s[^>]*>.*?</abbr>', '', content)
if'<'incontent_without_abbr:
result=re.sub(r'\s*class="(?:external|internal)-link"', '', match)
result=re.sub(r'\s*target="[^"]*"', '', result)
returnresultreturnf"[{content}]({href})"defprocess_file(filepath: Path, dry_run: bool=False) ->tuple[int, list[str]]:
"""Process a single file. Returns (change_count, list of changes)."""text=filepath.read_text(encoding="utf-8")
original=textchanges: list[str] = []
# Pattern 1: HTML <a> tags with class="external-link" or class="internal-link"# Handles attributes in any orderhtml_class_pattern=re.compile(
r'<a\s+'r'(?=[^>]*class="(?:external|internal)-link")'# must have the classr'[^>]*?'# other attrs before hrefr'href="[^"]*"'# hrefr'[^>]*?'# other attrsr'>'# end of opening tagr'.+?'# contentr'</a>', # closing tagre.DOTALL,
)
defreplace_html_class(m: re.Match) ->str:
result=convert_html_link_to_markdown(m.group(0))
ifresult!=m.group(0):
changes.append(f" HTML class → MD: {m.group(0)[:80]}...")
returnresulttext=html_class_pattern.sub(replace_html_class, text)
# Pattern 2: HTML <a> tags with target="_blank" but no link class# (these may have been left by previous runs or were never classed)html_target_pattern=re.compile(
r'<a\s+'r'(?=[^>]*target="_blank")'# must have target=_blankr'(?![^>]*class=")'# must NOT have a class attrr'[^>]*?'# other attrs before hrefr'href="[^"]*"'# hrefr'[^>]*?'# other attrsr'>'# end of opening tagr'.+?'# contentr'</a>', # closing tagre.DOTALL,
)
defreplace_html_target(m: re.Match) ->str:
result=convert_html_link_to_markdown(m.group(0))
ifresult!=m.group(0):
changes.append(f" HTML target → MD: {m.group(0)[:80]}...")
returnresulttext=html_target_pattern.sub(replace_html_target, text)
# Pattern 3: Markdown attr_list with .external-link or .internal-link# [Text](URL){.internal-link target=_blank} → [Text](URL)# [Text](URL){.external-link target=_blank} → [Text](URL)md_class_pattern=re.compile(
r'(\[[^\]]+\]\([^)]+\))'# [text](url)r'\{'# {r'\.(?:external|internal)-link'# .external-link or .internal-linkr'\s*'# optional spacer'([^}]*?)'# remaining attrs (e.g. target=_blank)r'\}'# }
)
defreplace_md_class(m: re.Match) ->str:
link_part=m.group(1)
remaining_attrs=m.group(2).strip()
# Remove target=_blank from remaining attrsremaining_attrs=re.sub(r'target=_blank\s*', '', remaining_attrs).strip()
ifremaining_attrs:
result=f"{link_part}{{{remaining_attrs}}}"else:
result=link_partchanges.append(f" MD class attr: {m.group(0)[:80]}...")
returnresulttext=md_class_pattern.sub(replace_md_class, text)
# Pattern 4: Markdown attr_list with only target=_blank (no class)# [Text](URL){target=_blank} → [Text](URL)md_target_pattern=re.compile(
r'(\[[^\]]+\]\([^)]+\))'# [text](url)r'\{target=_blank\}'# {target=_blank}
)
defreplace_md_target(m: re.Match) ->str:
changes.append(f" MD target attr: {m.group(0)[:80]}...")
returnm.group(1)
text=md_target_pattern.sub(replace_md_target, text)
iftext!=original:
ifnotdry_run:
filepath.write_text(text, encoding="utf-8")
returnlen(changes), changesreturn0, []
defmain() ->None:
dry_run="--dry-run"insys.argvdocs_dir=Path("docs")
ifnotdocs_dir.exists():
print(f"Error: {docs_dir} not found. Run from the repo root.")
sys.exit(1)
total_changes=0files_changed=0formd_fileinsorted(docs_dir.rglob("*.md")):
count, changes=process_file(md_file, dry_run=dry_run)
ifcount:
files_changed+=1total_changes+=countprint(f"{md_file} ({count} changes)")
forcinchanges:
print(c)
mode="DRY RUN"ifdry_runelse"APPLIED"print(f"\n{mode}: {total_changes} changes across {files_changed} files")
if__name__=="__main__":
main()
@github-actionsgithub-actionsBot
added
the 
docs
Improvements or additions to documentation
label
Mar 5, 2026
@github-actions
github-actionsBot
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
📝 Docs preview
Last commit 21e4f38 at: https://2ebc30aa.sqlmodel.pages.dev
Modified Pages
@github-actionsgithub-actionsBot
added
the 
conflicts
Automatically generated when a PR has a merge conflict
label
May 18, 2026
@github-actions
github-actionsBot
commented
May 18, 2026

Copy link


Copy Markdown

Contributor
This pull request has a merge conflict that needs to be resolved.
@github-actionsgithub-actionsBot
removed
the 
conflicts
Automatically generated when a PR has a merge conflict
label
May 18, 2026
@tiangolo
tiangolo
merged commit be45a56
into
mainMay 18, 2026

28 checks passed

@tiangolo
tiangolo
deleted the

no-blank

branch
May 18, 2026 12:15
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels

docsImprovements or additions to documentation

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@tiangolo

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
📝 Update link syntax to minimal Markdown - #1800
Merged
tiangolo merged 3 commits into
mainfrom 
no-blank
May 18, 2026
Merged
📝 Update link syntax to minimal Markdown#1800
tiangolo merged 3 commits into
mainfrom 
no-blank
Conversation
@tiangolo
@tiangolotiangolo
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

Member
📝 Update link syntax to minimal Markdown
No longer use the classes external-link and internal-link, remove target=_blank, which is now added automatically by JS, and move from HTML to Markdown syntax (as now it no longer needs anything from HTML).
The migration was done automatically with this script, generated with Claude Opus 4.6, the results were reviewed by (human) hand one by one.
Copied from fastapi/fastapi#15061
#!/usr/bin/env python3"""Remove .external-link and .internal-link classes and target=_blank from docs,converting HTML <a> tags to Markdown links where possible.Handles these patterns:1. HTML external/internal links (simple text content): <a href="URL" class="external-link" target="_blank">Text</a> → [Text](URL)2. HTML links with <strong> content: <a href="URL" class="external-link" target="_blank"><strong>Text</strong></a> → [**Text**](URL)3. HTML links with <code> content: <a href="URL" class="external-link" target="_blank"><code>text</code></a> → [`text`](URL)4. HTML links with <abbr> (converted, abbr kept inline): <a href="URL" class="external-link" target="_blank"><abbr title="T">Text</abbr></a> → [<abbr title="T">Text</abbr>](URL)5. HTML links with mixed <abbr> + <code>/<strong> (converted): <a href="URL" class="external-link" target="_blank"><abbr>X</abbr> docs for <code>POST</code></a> → [<abbr>X</abbr> docs for `POST`](URL)6. Markdown attr_list (.internal-link or .external-link and target=_blank removed): [Text](URL){.internal-link target=_blank} → [Text](URL)7. HTML <a> tags without link classes but with target="_blank" (class stripped, target removed): <a href="URL" target="_blank">Text</a> → [Text](URL)8. Markdown attr_list with only target=_blank (removed): [Text](URL){target=_blank} → [Text](URL)"""importreimportsysfrompathlibimportPathdefconvert_html_link_to_markdown(match: str) ->str:
"""Convert <a> tag to markdown link, stripping class and target."""# Extract hrefhref_m=re.search(r'href="([^"]*)"', match)
ifnothref_m:
returnmatchhref=href_m.group(1)
# Extract inner content (between > and </a>)content_m=re.search(r'>(.+?)</a>\s*$', match, re.DOTALL)
ifnotcontent_m:
returnmatchcontent=content_m.group(1).strip()
# Convert inline HTML to markdown equivalents# Convert <strong>text</strong> → **text**content=re.sub(r'<strong>(.*?)</strong>', r'**\1**', content)
# Convert <code>text</code> → `text`content=re.sub(r'<code>(.*?)</code>', r'`\1`', content)
# Convert <em>text</em> → *text*content=re.sub(r'<em>(.*?)</em>', r'*\1*', content)
# If there's still HTML other than <abbr> in the content, keep as HTML# but remove class and target attributescontent_without_abbr=re.sub(r'<abbr\s[^>]*>.*?</abbr>', '', content)
if'<'incontent_without_abbr:
result=re.sub(r'\s*class="(?:external|internal)-link"', '', match)
result=re.sub(r'\s*target="[^"]*"', '', result)
returnresultreturnf"[{content}]({href})"defprocess_file(filepath: Path, dry_run: bool=False) ->tuple[int, list[str]]:
"""Process a single file. Returns (change_count, list of changes)."""text=filepath.read_text(encoding="utf-8")
original=textchanges: list[str] = []
# Pattern 1: HTML <a> tags with class="external-link" or class="internal-link"# Handles attributes in any orderhtml_class_pattern=re.compile(
r'<a\s+'r'(?=[^>]*class="(?:external|internal)-link")'# must have the classr'[^>]*?'# other attrs before hrefr'href="[^"]*"'# hrefr'[^>]*?'# other attrsr'>'# end of opening tagr'.+?'# contentr'</a>', # closing tagre.DOTALL,
)
defreplace_html_class(m: re.Match) ->str:
result=convert_html_link_to_markdown(m.group(0))
ifresult!=m.group(0):
changes.append(f" HTML class → MD: {m.group(0)[:80]}...")
returnresulttext=html_class_pattern.sub(replace_html_class, text)
# Pattern 2: HTML <a> tags with target="_blank" but no link class# (these may have been left by previous runs or were never classed)html_target_pattern=re.compile(
r'<a\s+'r'(?=[^>]*target="_blank")'# must have target=_blankr'(?![^>]*class=")'# must NOT have a class attrr'[^>]*?'# other attrs before hrefr'href="[^"]*"'# hrefr'[^>]*?'# other attrsr'>'# end of opening tagr'.+?'# contentr'</a>', # closing tagre.DOTALL,
)
defreplace_html_target(m: re.Match) ->str:
result=convert_html_link_to_markdown(m.group(0))
ifresult!=m.group(0):
changes.append(f" HTML target → MD: {m.group(0)[:80]}...")
returnresulttext=html_target_pattern.sub(replace_html_target, text)
# Pattern 3: Markdown attr_list with .external-link or .internal-link# [Text](URL){.internal-link target=_blank} → [Text](URL)# [Text](URL){.external-link target=_blank} → [Text](URL)md_class_pattern=re.compile(
r'(\[[^\]]+\]\([^)]+\))'# [text](url)r'\{'# {r'\.(?:external|internal)-link'# .external-link or .internal-linkr'\s*'# optional spacer'([^}]*?)'# remaining attrs (e.g. target=_blank)r'\}'# }
)
defreplace_md_class(m: re.Match) ->str:
link_part=m.group(1)
remaining_attrs=m.group(2).strip()
# Remove target=_blank from remaining attrsremaining_attrs=re.sub(r'target=_blank\s*', '', remaining_attrs).strip()
ifremaining_attrs:
result=f"{link_part}{{{remaining_attrs}}}"else:
result=link_partchanges.append(f" MD class attr: {m.group(0)[:80]}...")
returnresulttext=md_class_pattern.sub(replace_md_class, text)
# Pattern 4: Markdown attr_list with only target=_blank (no class)# [Text](URL){target=_blank} → [Text](URL)md_target_pattern=re.compile(
r'(\[[^\]]+\]\([^)]+\))'# [text](url)r'\{target=_blank\}'# {target=_blank}
)
defreplace_md_target(m: re.Match) ->str:
changes.append(f" MD target attr: {m.group(0)[:80]}...")
returnm.group(1)
text=md_target_pattern.sub(replace_md_target, text)
iftext!=original:
ifnotdry_run:
filepath.write_text(text, encoding="utf-8")
returnlen(changes), changesreturn0, []
defmain() ->None:
dry_run="--dry-run"insys.argvdocs_dir=Path("docs")
ifnotdocs_dir.exists():
print(f"Error: {docs_dir} not found. Run from the repo root.")
sys.exit(1)
total_changes=0files_changed=0formd_fileinsorted(docs_dir.rglob("*.md")):
count, changes=process_file(md_file, dry_run=dry_run)
ifcount:
files_changed+=1total_changes+=countprint(f"{md_file} ({count} changes)")
forcinchanges:
print(c)
mode="DRY RUN"ifdry_runelse"APPLIED"print(f"\n{mode}: {total_changes} changes across {files_changed} files")
if__name__=="__main__":
main()
@github-actionsgithub-actionsBot
added
the 
docs
Improvements or additions to documentation
label
Mar 5, 2026
@github-actions
github-actionsBot
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
📝 Docs preview
Last commit 21e4f38 at: https://2ebc30aa.sqlmodel.pages.dev
Modified Pages
@github-actionsgithub-actionsBot
added
the 
conflicts
Automatically generated when a PR has a merge conflict
label
May 18, 2026
@github-actions
github-actionsBot
commented
May 18, 2026

Copy link


Copy Markdown

Contributor
This pull request has a merge conflict that needs to be resolved.
@github-actionsgithub-actionsBot
removed
the 
conflicts
Automatically generated when a PR has a merge conflict
label
May 18, 2026
@tiangolo
tiangolo
merged commit be45a56
into
mainMay 18, 2026

28 checks passed

@tiangolo
tiangolo
deleted the

no-blank

branch
May 18, 2026 12:15
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels

docsImprovements or additions to documentation

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@tiangolo

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
📝 Update link syntax to minimal Markdown - #1800
Merged
tiangolo merged 3 commits into
mainfrom 
no-blank
May 18, 2026
Merged
📝 Update link syntax to minimal Markdown#1800
tiangolo merged 3 commits into
mainfrom 
no-blank
Conversation
@tiangolo
@tiangolotiangolo
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

Member
📝 Update link syntax to minimal Markdown
No longer use the classes external-link and internal-link, remove target=_blank, which is now added automatically by JS, and move from HTML to Markdown syntax (as now it no longer needs anything from HTML).
The migration was done automatically with this script, generated with Claude Opus 4.6, the results were reviewed by (human) hand one by one.
Copied from fastapi/fastapi#15061
#!/usr/bin/env python3"""Remove .external-link and .internal-link classes and target=_blank from docs,converting HTML <a> tags to Markdown links where possible.Handles these patterns:1. HTML external/internal links (simple text content): <a href="URL" class="external-link" target="_blank">Text</a> → [Text](URL)2. HTML links with <strong> content: <a href="URL" class="external-link" target="_blank"><strong>Text</strong></a> → [**Text**](URL)3. HTML links with <code> content: <a href="URL" class="external-link" target="_blank"><code>text</code></a> → [`text`](URL)4. HTML links with <abbr> (converted, abbr kept inline): <a href="URL" class="external-link" target="_blank"><abbr title="T">Text</abbr></a> → [<abbr title="T">Text</abbr>](URL)5. HTML links with mixed <abbr> + <code>/<strong> (converted): <a href="URL" class="external-link" target="_blank"><abbr>X</abbr> docs for <code>POST</code></a> → [<abbr>X</abbr> docs for `POST`](URL)6. Markdown attr_list (.internal-link or .external-link and target=_blank removed): [Text](URL){.internal-link target=_blank} → [Text](URL)7. HTML <a> tags without link classes but with target="_blank" (class stripped, target removed): <a href="URL" target="_blank">Text</a> → [Text](URL)8. Markdown attr_list with only target=_blank (removed): [Text](URL){target=_blank} → [Text](URL)"""importreimportsysfrompathlibimportPathdefconvert_html_link_to_markdown(match: str) ->str:
"""Convert <a> tag to markdown link, stripping class and target."""# Extract hrefhref_m=re.search(r'href="([^"]*)"', match)
ifnothref_m:
returnmatchhref=href_m.group(1)
# Extract inner content (between > and </a>)content_m=re.search(r'>(.+?)</a>\s*$', match, re.DOTALL)
ifnotcontent_m:
returnmatchcontent=content_m.group(1).strip()
# Convert inline HTML to markdown equivalents# Convert <strong>text</strong> → **text**content=re.sub(r'<strong>(.*?)</strong>', r'**\1**', content)
# Convert <code>text</code> → `text`content=re.sub(r'<code>(.*?)</code>', r'`\1`', content)
# Convert <em>text</em> → *text*content=re.sub(r'<em>(.*?)</em>', r'*\1*', content)
# If there's still HTML other than <abbr> in the content, keep as HTML# but remove class and target attributescontent_without_abbr=re.sub(r'<abbr\s[^>]*>.*?</abbr>', '', content)
if'<'incontent_without_abbr:
result=re.sub(r'\s*class="(?:external|internal)-link"', '', match)
result=re.sub(r'\s*target="[^"]*"', '', result)
returnresultreturnf"[{content}]({href})"defprocess_file(filepath: Path, dry_run: bool=False) ->tuple[int, list[str]]:
"""Process a single file. Returns (change_count, list of changes)."""text=filepath.read_text(encoding="utf-8")
original=textchanges: list[str] = []
# Pattern 1: HTML <a> tags with class="external-link" or class="internal-link"# Handles attributes in any orderhtml_class_pattern=re.compile(
r'<a\s+'r'(?=[^>]*class="(?:external|internal)-link")'# must have the classr'[^>]*?'# other attrs before hrefr'href="[^"]*"'# hrefr'[^>]*?'# other attrsr'>'# end of opening tagr'.+?'# contentr'</a>', # closing tagre.DOTALL,
)
defreplace_html_class(m: re.Match) ->str:
result=convert_html_link_to_markdown(m.group(0))
ifresult!=m.group(0):
changes.append(f" HTML class → MD: {m.group(0)[:80]}...")
returnresulttext=html_class_pattern.sub(replace_html_class, text)
# Pattern 2: HTML <a> tags with target="_blank" but no link class# (these may have been left by previous runs or were never classed)html_target_pattern=re.compile(
r'<a\s+'r'(?=[^>]*target="_blank")'# must have target=_blankr'(?![^>]*class=")'# must NOT have a class attrr'[^>]*?'# other attrs before hrefr'href="[^"]*"'# hrefr'[^>]*?'# other attrsr'>'# end of opening tagr'.+?'# contentr'</a>', # closing tagre.DOTALL,
)
defreplace_html_target(m: re.Match) ->str:
result=convert_html_link_to_markdown(m.group(0))
ifresult!=m.group(0):
changes.append(f" HTML target → MD: {m.group(0)[:80]}...")
returnresulttext=html_target_pattern.sub(replace_html_target, text)
# Pattern 3: Markdown attr_list with .external-link or .internal-link# [Text](URL){.internal-link target=_blank} → [Text](URL)# [Text](URL){.external-link target=_blank} → [Text](URL)md_class_pattern=re.compile(
r'(\[[^\]]+\]\([^)]+\))'# [text](url)r'\{'# {r'\.(?:external|internal)-link'# .external-link or .internal-linkr'\s*'# optional spacer'([^}]*?)'# remaining attrs (e.g. target=_blank)r'\}'# }
)
defreplace_md_class(m: re.Match) ->str:
link_part=m.group(1)
remaining_attrs=m.group(2).strip()
# Remove target=_blank from remaining attrsremaining_attrs=re.sub(r'target=_blank\s*', '', remaining_attrs).strip()
ifremaining_attrs:
result=f"{link_part}{{{remaining_attrs}}}"else:
result=link_partchanges.append(f" MD class attr: {m.group(0)[:80]}...")
returnresulttext=md_class_pattern.sub(replace_md_class, text)
# Pattern 4: Markdown attr_list with only target=_blank (no class)# [Text](URL){target=_blank} → [Text](URL)md_target_pattern=re.compile(
r'(\[[^\]]+\]\([^)]+\))'# [text](url)r'\{target=_blank\}'# {target=_blank}
)
defreplace_md_target(m: re.Match) ->str:
changes.append(f" MD target attr: {m.group(0)[:80]}...")
returnm.group(1)
text=md_target_pattern.sub(replace_md_target, text)
iftext!=original:
ifnotdry_run:
filepath.write_text(text, encoding="utf-8")
returnlen(changes), changesreturn0, []
defmain() ->None:
dry_run="--dry-run"insys.argvdocs_dir=Path("docs")
ifnotdocs_dir.exists():
print(f"Error: {docs_dir} not found. Run from the repo root.")
sys.exit(1)
total_changes=0files_changed=0formd_fileinsorted(docs_dir.rglob("*.md")):
count, changes=process_file(md_file, dry_run=dry_run)
ifcount:
files_changed+=1total_changes+=countprint(f"{md_file} ({count} changes)")
forcinchanges:
print(c)
mode="DRY RUN"ifdry_runelse"APPLIED"print(f"\n{mode}: {total_changes} changes across {files_changed} files")
if__name__=="__main__":
main()
@github-actionsgithub-actionsBot
added
the 
docs
Improvements or additions to documentation
label
Mar 5, 2026
@github-actions
github-actionsBot
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
📝 Docs preview
Last commit 21e4f38 at: https://2ebc30aa.sqlmodel.pages.dev
Modified Pages
@github-actionsgithub-actionsBot
added
the 
conflicts
Automatically generated when a PR has a merge conflict
label
May 18, 2026
@github-actions
github-actionsBot
commented
May 18, 2026

Copy link


Copy Markdown

Contributor
This pull request has a merge conflict that needs to be resolved.
@github-actionsgithub-actionsBot
removed
the 
conflicts
Automatically generated when a PR has a merge conflict
label
May 18, 2026
@tiangolo
tiangolo
merged commit be45a56
into
mainMay 18, 2026

28 checks passed

@tiangolo
tiangolo
deleted the

no-blank

branch
May 18, 2026 12:15
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels

docsImprovements or additions to documentation

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@tiangolo

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
📝 Update link syntax to minimal Markdown - #1800
Merged
tiangolo merged 3 commits into
mainfrom 
no-blank
May 18, 2026
Merged
📝 Update link syntax to minimal Markdown#1800
tiangolo merged 3 commits into
mainfrom 
no-blank
Conversation
@tiangolo
@tiangolotiangolo
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

Member
📝 Update link syntax to minimal Markdown
No longer use the classes external-link and internal-link, remove target=_blank, which is now added automatically by JS, and move from HTML to Markdown syntax (as now it no longer needs anything from HTML).
The migration was done automatically with this script, generated with Claude Opus 4.6, the results were reviewed by (human) hand one by one.
Copied from fastapi/fastapi#15061
#!/usr/bin/env python3"""Remove .external-link and .internal-link classes and target=_blank from docs,converting HTML <a> tags to Markdown links where possible.Handles these patterns:1. HTML external/internal links (simple text content): <a href="URL" class="external-link" target="_blank">Text</a> → [Text](URL)2. HTML links with <strong> content: <a href="URL" class="external-link" target="_blank"><strong>Text</strong></a> → [**Text**](URL)3. HTML links with <code> content: <a href="URL" class="external-link" target="_blank"><code>text</code></a> → [`text`](URL)4. HTML links with <abbr> (converted, abbr kept inline): <a href="URL" class="external-link" target="_blank"><abbr title="T">Text</abbr></a> → [<abbr title="T">Text</abbr>](URL)5. HTML links with mixed <abbr> + <code>/<strong> (converted): <a href="URL" class="external-link" target="_blank"><abbr>X</abbr> docs for <code>POST</code></a> → [<abbr>X</abbr> docs for `POST`](URL)6. Markdown attr_list (.internal-link or .external-link and target=_blank removed): [Text](URL){.internal-link target=_blank} → [Text](URL)7. HTML <a> tags without link classes but with target="_blank" (class stripped, target removed): <a href="URL" target="_blank">Text</a> → [Text](URL)8. Markdown attr_list with only target=_blank (removed): [Text](URL){target=_blank} → [Text](URL)"""importreimportsysfrompathlibimportPathdefconvert_html_link_to_markdown(match: str) ->str:
"""Convert <a> tag to markdown link, stripping class and target."""# Extract hrefhref_m=re.search(r'href="([^"]*)"', match)
ifnothref_m:
returnmatchhref=href_m.group(1)
# Extract inner content (between > and </a>)content_m=re.search(r'>(.+?)</a>\s*$', match, re.DOTALL)
ifnotcontent_m:
returnmatchcontent=content_m.group(1).strip()
# Convert inline HTML to markdown equivalents# Convert <strong>text</strong> → **text**content=re.sub(r'<strong>(.*?)</strong>', r'**\1**', content)
# Convert <code>text</code> → `text`content=re.sub(r'<code>(.*?)</code>', r'`\1`', content)
# Convert <em>text</em> → *text*content=re.sub(r'<em>(.*?)</em>', r'*\1*', content)
# If there's still HTML other than <abbr> in the content, keep as HTML# but remove class and target attributescontent_without_abbr=re.sub(r'<abbr\s[^>]*>.*?</abbr>', '', content)
if'<'incontent_without_abbr:
result=re.sub(r'\s*class="(?:external|internal)-link"', '', match)
result=re.sub(r'\s*target="[^"]*"', '', result)
returnresultreturnf"[{content}]({href})"defprocess_file(filepath: Path, dry_run: bool=False) ->tuple[int, list[str]]:
"""Process a single file. Returns (change_count, list of changes)."""text=filepath.read_text(encoding="utf-8")
original=textchanges: list[str] = []
# Pattern 1: HTML <a> tags with class="external-link" or class="internal-link"# Handles attributes in any orderhtml_class_pattern=re.compile(
r'<a\s+'r'(?=[^>]*class="(?:external|internal)-link")'# must have the classr'[^>]*?'# other attrs before hrefr'href="[^"]*"'# hrefr'[^>]*?'# other attrsr'>'# end of opening tagr'.+?'# contentr'</a>', # closing tagre.DOTALL,
)
defreplace_html_class(m: re.Match) ->str:
result=convert_html_link_to_markdown(m.group(0))
ifresult!=m.group(0):
changes.append(f" HTML class → MD: {m.group(0)[:80]}...")
returnresulttext=html_class_pattern.sub(replace_html_class, text)
# Pattern 2: HTML <a> tags with target="_blank" but no link class# (these may have been left by previous runs or were never classed)html_target_pattern=re.compile(
r'<a\s+'r'(?=[^>]*target="_blank")'# must have target=_blankr'(?![^>]*class=")'# must NOT have a class attrr'[^>]*?'# other attrs before hrefr'href="[^"]*"'# hrefr'[^>]*?'# other attrsr'>'# end of opening tagr'.+?'# contentr'</a>', # closing tagre.DOTALL,
)
defreplace_html_target(m: re.Match) ->str:
result=convert_html_link_to_markdown(m.group(0))
ifresult!=m.group(0):
changes.append(f" HTML target → MD: {m.group(0)[:80]}...")
returnresulttext=html_target_pattern.sub(replace_html_target, text)
# Pattern 3: Markdown attr_list with .external-link or .internal-link# [Text](URL){.internal-link target=_blank} → [Text](URL)# [Text](URL){.external-link target=_blank} → [Text](URL)md_class_pattern=re.compile(
r'(\[[^\]]+\]\([^)]+\))'# [text](url)r'\{'# {r'\.(?:external|internal)-link'# .external-link or .internal-linkr'\s*'# optional spacer'([^}]*?)'# remaining attrs (e.g. target=_blank)r'\}'# }
)
defreplace_md_class(m: re.Match) ->str:
link_part=m.group(1)
remaining_attrs=m.group(2).strip()
# Remove target=_blank from remaining attrsremaining_attrs=re.sub(r'target=_blank\s*', '', remaining_attrs).strip()
ifremaining_attrs:
result=f"{link_part}{{{remaining_attrs}}}"else:
result=link_partchanges.append(f" MD class attr: {m.group(0)[:80]}...")
returnresulttext=md_class_pattern.sub(replace_md_class, text)
# Pattern 4: Markdown attr_list with only target=_blank (no class)# [Text](URL){target=_blank} → [Text](URL)md_target_pattern=re.compile(
r'(\[[^\]]+\]\([^)]+\))'# [text](url)r'\{target=_blank\}'# {target=_blank}
)
defreplace_md_target(m: re.Match) ->str:
changes.append(f" MD target attr: {m.group(0)[:80]}...")
returnm.group(1)
text=md_target_pattern.sub(replace_md_target, text)
iftext!=original:
ifnotdry_run:
filepath.write_text(text, encoding="utf-8")
returnlen(changes), changesreturn0, []
defmain() ->None:
dry_run="--dry-run"insys.argvdocs_dir=Path("docs")
ifnotdocs_dir.exists():
print(f"Error: {docs_dir} not found. Run from the repo root.")
sys.exit(1)
total_changes=0files_changed=0formd_fileinsorted(docs_dir.rglob("*.md")):
count, changes=process_file(md_file, dry_run=dry_run)
ifcount:
files_changed+=1total_changes+=countprint(f"{md_file} ({count} changes)")
forcinchanges:
print(c)
mode="DRY RUN"ifdry_runelse"APPLIED"print(f"\n{mode}: {total_changes} changes across {files_changed} files")
if__name__=="__main__":
main()
@github-actionsgithub-actionsBot
added
the 
docs
Improvements or additions to documentation
label
Mar 5, 2026
@github-actions
github-actionsBot
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
📝 Docs preview
Last commit 21e4f38 at: https://2ebc30aa.sqlmodel.pages.dev
Modified Pages
@github-actionsgithub-actionsBot
added
the 
conflicts
Automatically generated when a PR has a merge conflict
label
May 18, 2026
@github-actions
github-actionsBot
commented
May 18, 2026

Copy link


Copy Markdown

Contributor
This pull request has a merge conflict that needs to be resolved.
@github-actionsgithub-actionsBot
removed
the 
conflicts
Automatically generated when a PR has a merge conflict
label
May 18, 2026
@tiangolo
tiangolo
merged commit be45a56
into
mainMay 18, 2026

28 checks passed

@tiangolo
tiangolo
deleted the

no-blank

branch
May 18, 2026 12:15
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels

docsImprovements or additions to documentation

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@tiangolo

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
📝 Update link syntax to minimal Markdown - #1800
Merged
tiangolo merged 3 commits into
mainfrom 
no-blank
May 18, 2026
Merged
📝 Update link syntax to minimal Markdown#1800
tiangolo merged 3 commits into
mainfrom 
no-blank
Conversation
@tiangolo
@tiangolotiangolo
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

Member
📝 Update link syntax to minimal Markdown
No longer use the classes external-link and internal-link, remove target=_blank, which is now added automatically by JS, and move from HTML to Markdown syntax (as now it no longer needs anything from HTML).
The migration was done automatically with this script, generated with Claude Opus 4.6, the results were reviewed by (human) hand one by one.
Copied from fastapi/fastapi#15061
#!/usr/bin/env python3"""Remove .external-link and .internal-link classes and target=_blank from docs,converting HTML <a> tags to Markdown links where possible.Handles these patterns:1. HTML external/internal links (simple text content): <a href="URL" class="external-link" target="_blank">Text</a> → [Text](URL)2. HTML links with <strong> content: <a href="URL" class="external-link" target="_blank"><strong>Text</strong></a> → [**Text**](URL)3. HTML links with <code> content: <a href="URL" class="external-link" target="_blank"><code>text</code></a> → [`text`](URL)4. HTML links with <abbr> (converted, abbr kept inline): <a href="URL" class="external-link" target="_blank"><abbr title="T">Text</abbr></a> → [<abbr title="T">Text</abbr>](URL)5. HTML links with mixed <abbr> + <code>/<strong> (converted): <a href="URL" class="external-link" target="_blank"><abbr>X</abbr> docs for <code>POST</code></a> → [<abbr>X</abbr> docs for `POST`](URL)6. Markdown attr_list (.internal-link or .external-link and target=_blank removed): [Text](URL){.internal-link target=_blank} → [Text](URL)7. HTML <a> tags without link classes but with target="_blank" (class stripped, target removed): <a href="URL" target="_blank">Text</a> → [Text](URL)8. Markdown attr_list with only target=_blank (removed): [Text](URL){target=_blank} → [Text](URL)"""importreimportsysfrompathlibimportPathdefconvert_html_link_to_markdown(match: str) ->str:
"""Convert <a> tag to markdown link, stripping class and target."""# Extract hrefhref_m=re.search(r'href="([^"]*)"', match)
ifnothref_m:
returnmatchhref=href_m.group(1)
# Extract inner content (between > and </a>)content_m=re.search(r'>(.+?)</a>\s*$', match, re.DOTALL)
ifnotcontent_m:
returnmatchcontent=content_m.group(1).strip()
# Convert inline HTML to markdown equivalents# Convert <strong>text</strong> → **text**content=re.sub(r'<strong>(.*?)</strong>', r'**\1**', content)
# Convert <code>text</code> → `text`content=re.sub(r'<code>(.*?)</code>', r'`\1`', content)
# Convert <em>text</em> → *text*content=re.sub(r'<em>(.*?)</em>', r'*\1*', content)
# If there's still HTML other than <abbr> in the content, keep as HTML# but remove class and target attributescontent_without_abbr=re.sub(r'<abbr\s[^>]*>.*?</abbr>', '', content)
if'<'incontent_without_abbr:
result=re.sub(r'\s*class="(?:external|internal)-link"', '', match)
result=re.sub(r'\s*target="[^"]*"', '', result)
returnresultreturnf"[{content}]({href})"defprocess_file(filepath: Path, dry_run: bool=False) ->tuple[int, list[str]]:
"""Process a single file. Returns (change_count, list of changes)."""text=filepath.read_text(encoding="utf-8")
original=textchanges: list[str] = []
# Pattern 1: HTML <a> tags with class="external-link" or class="internal-link"# Handles attributes in any orderhtml_class_pattern=re.compile(
r'<a\s+'r'(?=[^>]*class="(?:external|internal)-link")'# must have the classr'[^>]*?'# other attrs before hrefr'href="[^"]*"'# hrefr'[^>]*?'# other attrsr'>'# end of opening tagr'.+?'# contentr'</a>', # closing tagre.DOTALL,
)
defreplace_html_class(m: re.Match) ->str:
result=convert_html_link_to_markdown(m.group(0))
ifresult!=m.group(0):
changes.append(f" HTML class → MD: {m.group(0)[:80]}...")
returnresulttext=html_class_pattern.sub(replace_html_class, text)
# Pattern 2: HTML <a> tags with target="_blank" but no link class# (these may have been left by previous runs or were never classed)html_target_pattern=re.compile(
r'<a\s+'r'(?=[^>]*target="_blank")'# must have target=_blankr'(?![^>]*class=")'# must NOT have a class attrr'[^>]*?'# other attrs before hrefr'href="[^"]*"'# hrefr'[^>]*?'# other attrsr'>'# end of opening tagr'.+?'# contentr'</a>', # closing tagre.DOTALL,
)
defreplace_html_target(m: re.Match) ->str:
result=convert_html_link_to_markdown(m.group(0))
ifresult!=m.group(0):
changes.append(f" HTML target → MD: {m.group(0)[:80]}...")
returnresulttext=html_target_pattern.sub(replace_html_target, text)
# Pattern 3: Markdown attr_list with .external-link or .internal-link# [Text](URL){.internal-link target=_blank} → [Text](URL)# [Text](URL){.external-link target=_blank} → [Text](URL)md_class_pattern=re.compile(
r'(\[[^\]]+\]\([^)]+\))'# [text](url)r'\{'# {r'\.(?:external|internal)-link'# .external-link or .internal-linkr'\s*'# optional spacer'([^}]*?)'# remaining attrs (e.g. target=_blank)r'\}'# }
)
defreplace_md_class(m: re.Match) ->str:
link_part=m.group(1)
remaining_attrs=m.group(2).strip()
# Remove target=_blank from remaining attrsremaining_attrs=re.sub(r'target=_blank\s*', '', remaining_attrs).strip()
ifremaining_attrs:
result=f"{link_part}{{{remaining_attrs}}}"else:
result=link_partchanges.append(f" MD class attr: {m.group(0)[:80]}...")
returnresulttext=md_class_pattern.sub(replace_md_class, text)
# Pattern 4: Markdown attr_list with only target=_blank (no class)# [Text](URL){target=_blank} → [Text](URL)md_target_pattern=re.compile(
r'(\[[^\]]+\]\([^)]+\))'# [text](url)r'\{target=_blank\}'# {target=_blank}
)
defreplace_md_target(m: re.Match) ->str:
changes.append(f" MD target attr: {m.group(0)[:80]}...")
returnm.group(1)
text=md_target_pattern.sub(replace_md_target, text)
iftext!=original:
ifnotdry_run:
filepath.write_text(text, encoding="utf-8")
returnlen(changes), changesreturn0, []
defmain() ->None:
dry_run="--dry-run"insys.argvdocs_dir=Path("docs")
ifnotdocs_dir.exists():
print(f"Error: {docs_dir} not found. Run from the repo root.")
sys.exit(1)
total_changes=0files_changed=0formd_fileinsorted(docs_dir.rglob("*.md")):
count, changes=process_file(md_file, dry_run=dry_run)
ifcount:
files_changed+=1total_changes+=countprint(f"{md_file} ({count} changes)")
forcinchanges:
print(c)
mode="DRY RUN"ifdry_runelse"APPLIED"print(f"\n{mode}: {total_changes} changes across {files_changed} files")
if__name__=="__main__":
main()
@github-actionsgithub-actionsBot
added
the 
docs
Improvements or additions to documentation
label
Mar 5, 2026
@github-actions
github-actionsBot
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
📝 Docs preview
Last commit 21e4f38 at: https://2ebc30aa.sqlmodel.pages.dev
Modified Pages
@github-actionsgithub-actionsBot
added
the 
conflicts
Automatically generated when a PR has a merge conflict
label
May 18, 2026
@github-actions
github-actionsBot
commented
May 18, 2026

Copy link


Copy Markdown

Contributor
This pull request has a merge conflict that needs to be resolved.
@github-actionsgithub-actionsBot
removed
the 
conflicts
Automatically generated when a PR has a merge conflict
label
May 18, 2026
@tiangolo
tiangolo
merged commit be45a56
into
mainMay 18, 2026

28 checks passed

@tiangolo
tiangolo
deleted the

no-blank

branch
May 18, 2026 12:15
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels

docsImprovements or additions to documentation

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@tiangolo

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
📝 Update link syntax to minimal Markdown - #1800
Merged
tiangolo merged 3 commits into
mainfrom 
no-blank
May 18, 2026
Merged
📝 Update link syntax to minimal Markdown#1800
tiangolo merged 3 commits into
mainfrom 
no-blank
Conversation
@tiangolo
@tiangolotiangolo
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

Member
📝 Update link syntax to minimal Markdown
No longer use the classes external-link and internal-link, remove target=_blank, which is now added automatically by JS, and move from HTML to Markdown syntax (as now it no longer needs anything from HTML).
The migration was done automatically with this script, generated with Claude Opus 4.6, the results were reviewed by (human) hand one by one.
Copied from fastapi/fastapi#15061
#!/usr/bin/env python3"""Remove .external-link and .internal-link classes and target=_blank from docs,converting HTML <a> tags to Markdown links where possible.Handles these patterns:1. HTML external/internal links (simple text content): <a href="URL" class="external-link" target="_blank">Text</a> → [Text](URL)2. HTML links with <strong> content: <a href="URL" class="external-link" target="_blank"><strong>Text</strong></a> → [**Text**](URL)3. HTML links with <code> content: <a href="URL" class="external-link" target="_blank"><code>text</code></a> → [`text`](URL)4. HTML links with <abbr> (converted, abbr kept inline): <a href="URL" class="external-link" target="_blank"><abbr title="T">Text</abbr></a> → [<abbr title="T">Text</abbr>](URL)5. HTML links with mixed <abbr> + <code>/<strong> (converted): <a href="URL" class="external-link" target="_blank"><abbr>X</abbr> docs for <code>POST</code></a> → [<abbr>X</abbr> docs for `POST`](URL)6. Markdown attr_list (.internal-link or .external-link and target=_blank removed): [Text](URL){.internal-link target=_blank} → [Text](URL)7. HTML <a> tags without link classes but with target="_blank" (class stripped, target removed): <a href="URL" target="_blank">Text</a> → [Text](URL)8. Markdown attr_list with only target=_blank (removed): [Text](URL){target=_blank} → [Text](URL)"""importreimportsysfrompathlibimportPathdefconvert_html_link_to_markdown(match: str) ->str:
"""Convert <a> tag to markdown link, stripping class and target."""# Extract hrefhref_m=re.search(r'href="([^"]*)"', match)
ifnothref_m:
returnmatchhref=href_m.group(1)
# Extract inner content (between > and </a>)content_m=re.search(r'>(.+?)</a>\s*$', match, re.DOTALL)
ifnotcontent_m:
returnmatchcontent=content_m.group(1).strip()
# Convert inline HTML to markdown equivalents# Convert <strong>text</strong> → **text**content=re.sub(r'<strong>(.*?)</strong>', r'**\1**', content)
# Convert <code>text</code> → `text`content=re.sub(r'<code>(.*?)</code>', r'`\1`', content)
# Convert <em>text</em> → *text*content=re.sub(r'<em>(.*?)</em>', r'*\1*', content)
# If there's still HTML other than <abbr> in the content, keep as HTML# but remove class and target attributescontent_without_abbr=re.sub(r'<abbr\s[^>]*>.*?</abbr>', '', content)
if'<'incontent_without_abbr:
result=re.sub(r'\s*class="(?:external|internal)-link"', '', match)
result=re.sub(r'\s*target="[^"]*"', '', result)
returnresultreturnf"[{content}]({href})"defprocess_file(filepath: Path, dry_run: bool=False) ->tuple[int, list[str]]:
"""Process a single file. Returns (change_count, list of changes)."""text=filepath.read_text(encoding="utf-8")
original=textchanges: list[str] = []
# Pattern 1: HTML <a> tags with class="external-link" or class="internal-link"# Handles attributes in any orderhtml_class_pattern=re.compile(
r'<a\s+'r'(?=[^>]*class="(?:external|internal)-link")'# must have the classr'[^>]*?'# other attrs before hrefr'href="[^"]*"'# hrefr'[^>]*?'# other attrsr'>'# end of opening tagr'.+?'# contentr'</a>', # closing tagre.DOTALL,
)
defreplace_html_class(m: re.Match) ->str:
result=convert_html_link_to_markdown(m.group(0))
ifresult!=m.group(0):
changes.append(f" HTML class → MD: {m.group(0)[:80]}...")
returnresulttext=html_class_pattern.sub(replace_html_class, text)
# Pattern 2: HTML <a> tags with target="_blank" but no link class# (these may have been left by previous runs or were never classed)html_target_pattern=re.compile(
r'<a\s+'r'(?=[^>]*target="_blank")'# must have target=_blankr'(?![^>]*class=")'# must NOT have a class attrr'[^>]*?'# other attrs before hrefr'href="[^"]*"'# hrefr'[^>]*?'# other attrsr'>'# end of opening tagr'.+?'# contentr'</a>', # closing tagre.DOTALL,
)
defreplace_html_target(m: re.Match) ->str:
result=convert_html_link_to_markdown(m.group(0))
ifresult!=m.group(0):
changes.append(f" HTML target → MD: {m.group(0)[:80]}...")
returnresulttext=html_target_pattern.sub(replace_html_target, text)
# Pattern 3: Markdown attr_list with .external-link or .internal-link# [Text](URL){.internal-link target=_blank} → [Text](URL)# [Text](URL){.external-link target=_blank} → [Text](URL)md_class_pattern=re.compile(
r'(\[[^\]]+\]\([^)]+\))'# [text](url)r'\{'# {r'\.(?:external|internal)-link'# .external-link or .internal-linkr'\s*'# optional spacer'([^}]*?)'# remaining attrs (e.g. target=_blank)r'\}'# }
)
defreplace_md_class(m: re.Match) ->str:
link_part=m.group(1)
remaining_attrs=m.group(2).strip()
# Remove target=_blank from remaining attrsremaining_attrs=re.sub(r'target=_blank\s*', '', remaining_attrs).strip()
ifremaining_attrs:
result=f"{link_part}{{{remaining_attrs}}}"else:
result=link_partchanges.append(f" MD class attr: {m.group(0)[:80]}...")
returnresulttext=md_class_pattern.sub(replace_md_class, text)
# Pattern 4: Markdown attr_list with only target=_blank (no class)# [Text](URL){target=_blank} → [Text](URL)md_target_pattern=re.compile(
r'(\[[^\]]+\]\([^)]+\))'# [text](url)r'\{target=_blank\}'# {target=_blank}
)
defreplace_md_target(m: re.Match) ->str:
changes.append(f" MD target attr: {m.group(0)[:80]}...")
returnm.group(1)
text=md_target_pattern.sub(replace_md_target, text)
iftext!=original:
ifnotdry_run:
filepath.write_text(text, encoding="utf-8")
returnlen(changes), changesreturn0, []
defmain() ->None:
dry_run="--dry-run"insys.argvdocs_dir=Path("docs")
ifnotdocs_dir.exists():
print(f"Error: {docs_dir} not found. Run from the repo root.")
sys.exit(1)
total_changes=0files_changed=0formd_fileinsorted(docs_dir.rglob("*.md")):
count, changes=process_file(md_file, dry_run=dry_run)
ifcount:
files_changed+=1total_changes+=countprint(f"{md_file} ({count} changes)")
forcinchanges:
print(c)
mode="DRY RUN"ifdry_runelse"APPLIED"print(f"\n{mode}: {total_changes} changes across {files_changed} files")
if__name__=="__main__":
main()
@github-actionsgithub-actionsBot
added
the 
docs
Improvements or additions to documentation
label
Mar 5, 2026
@github-actions
github-actionsBot
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
📝 Docs preview
Last commit 21e4f38 at: https://2ebc30aa.sqlmodel.pages.dev
Modified Pages
@github-actionsgithub-actionsBot
added
the 
conflicts
Automatically generated when a PR has a merge conflict
label
May 18, 2026
@github-actions
github-actionsBot
commented
May 18, 2026

Copy link


Copy Markdown

Contributor
This pull request has a merge conflict that needs to be resolved.
@github-actionsgithub-actionsBot
removed
the 
conflicts
Automatically generated when a PR has a merge conflict
label
May 18, 2026
@tiangolo
tiangolo
merged commit be45a56
into
mainMay 18, 2026

28 checks passed

@tiangolo
tiangolo
deleted the

no-blank

branch
May 18, 2026 12:15
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels

docsImprovements or additions to documentation

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@tiangolo