🔧 Upgrade Material for MkDocs and remove insiders#1650

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.

Sign up for GitHub

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

Merged
tiangolo merged 1 commit into from
Nov 20, 2025
Merged

🔧 Upgrade Material for MkDocs and remove insiders #1650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 1 addition & 9 deletions .github/workflows/build-docs.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,12 +33,9 @@ jobs:
- docs/**
- docs_src/**
- requirements-docs.txt
- requirements-docs-insiders.txt
- pyproject.toml
- mkdocs.yml
- mkdocs.insiders.yml
- mkdocs.maybe-insiders.yml
- mkdocs.no-insiders.yml
- mkdocs.env.yml
- .github/workflows/build-docs.yml
- .github/workflows/deploy-docs.yml
- data/**
Expand DownExpand Up@@ -68,11 +65,6 @@ jobs:
pyproject.toml
- name: Install docs extras
run: uv pip install -r requirements-docs.txt
- name: Install Material for MkDocs Insiders
if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' )
run: uv pip install -r requirements-docs-insiders.txt
env:
TOKEN: ${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}
- uses: actions/cache@v4
with:
key: mkdocs-cards-${{ github.ref }}
Expand Down
1 change: 0 additions & 1 deletion mkdocs.maybe-insiders.yml → mkdocs.env.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
# Define this here and not in the main mkdocs.yml file because that one could be auto
# updated and written, and the script would remove the env var
INHERIT: !ENV [INSIDERS_FILE, './mkdocs.no-insiders.yml']
markdown_extensions:
pymdownx.highlight:
linenums: !ENV [LINENUMS, false]
7 changes: 0 additions & 7 deletions mkdocs.insiders.yml
View file
Open in desktop

This file was deleted.

Empty file removedmkdocs.no-insiders.yml
View file
Open in desktop
Empty file.
8 changes: 7 additions & 1 deletion mkdocs.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
INHERIT: ./mkdocs.maybe-insiders.yml
INHERIT: ./mkdocs.env.yml
site_name: SQLModel
site_description: SQLModel, SQL databases in Python, designed for simplicity, compatibility, and robustness.
site_url: https://sqlmodel.tiangolo.com/
Expand DownExpand Up@@ -58,6 +58,7 @@ plugins:
# Material for MkDocs
search:
social:
typeset:
# Other plugins
macros:
include_yaml:
Expand DownExpand Up@@ -140,6 +141,11 @@ nav:
- release-notes.md

markdown_extensions:
# Material for MkDocs
material.extensions.preview:
targets:
include:
- "*"
# Python Markdown
abbr:
attr_list:
Expand Down
3 changes: 0 additions & 3 deletions requirements-docs-insiders.txt
View file
Open in desktop

This file was deleted.

3 changes: 2 additions & 1 deletion requirements-docs.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,8 +10,9 @@ pyyaml >=5.3.1,<7.0.0
pillow==11.3.0
# For image processing by Material for MkDocs
cairosvg==2.8.2
# mkdocstrings[python]==0.25.1
mkdocstrings[python]==0.30.1
griffe-typingdoc==0.3.0
griffe-warnings-deprecated==1.1.0
# For griffe, it formats with black
typer == 0.20.0
mkdocs-macros-plugin==1.5.0
Expand Down
16 changes: 1 addition & 15 deletions scripts/docs.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,9 +2,7 @@
import os
import re
import subprocess
from functools import lru_cache
from http.server import HTTPServer, SimpleHTTPRequestHandler
from importlib import metadata
from pathlib import Path

import mkdocs.utils
Expand All@@ -19,17 +17,9 @@
app = typer.Typer()


@lru_cache
def is_mkdocs_insiders() -> bool:
version = metadata.version("mkdocs-material")
return "insiders" in version


@app.callback()
def callback() -> None:
if is_mkdocs_insiders():
os.environ["INSIDERS_FILE"] = "./mkdocs.insiders.yml"
# For MacOS with insiders and Cairo
# For MacOS with Cairo
os.environ["DYLD_FALLBACK_LIBRARY_PATH"] = "/opt/homebrew/lib"


Expand DownExpand Up@@ -126,10 +116,6 @@ def build() -> None:
"""
Build the docs.
"""
insiders_env_file = os.environ.get("INSIDERS_FILE")
print(f"Insiders file {insiders_env_file}")
if is_mkdocs_insiders():
print("Using insiders")
print("Building docs")
subprocess.run(["mkdocs", "build"], check=True)
typer.secho("Successfully built docs", color=typer.colors.GREEN)
Expand Down
Loading
, '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
🔧 Upgrade Material for MkDocs and remove insiders#1650

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.

 Sign up for GitHub

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

 Merged

tiangolo
merged 1 commit into

from

Nov 20, 2025
 Merged


🔧 Upgrade Material for MkDocs and remove insiders
#1650
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 1 addition & 9 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,12 +33,9 @@ jobs:
 - docs/**
 - docs_src/**
 - requirements-docs.txt
 - requirements-docs-insiders.txt
 - pyproject.toml
 - mkdocs.yml
 - mkdocs.insiders.yml
 - mkdocs.maybe-insiders.yml
 - mkdocs.no-insiders.yml
 - mkdocs.env.yml
 - .github/workflows/build-docs.yml
 - .github/workflows/deploy-docs.yml
 - data/**
Expand DownExpand Up@@ -68,11 +65,6 @@ jobs:
 pyproject.toml
 - name: Install docs extras
 run: uv pip install -r requirements-docs.txt
 - name: Install Material for MkDocs Insiders
 if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' )
 run: uv pip install -r requirements-docs-insiders.txt
 env:
 TOKEN: ${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}
 - uses: actions/cache@v4
 with:
 key: mkdocs-cards-${{ github.ref }}
Expand Down

1 change: 0 additions & 1 deletion
mkdocs.maybe-insiders.yml → mkdocs.env.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
# Define this here and not in the main mkdocs.yml file because that one could be auto
# updated and written, and the script would remove the env var
INHERIT: !ENV [INSIDERS_FILE, './mkdocs.no-insiders.yml']
markdown_extensions:
 pymdownx.highlight:
 linenums: !ENV [LINENUMS, false]

7 changes: 0 additions & 7 deletions
mkdocs.insiders.yml

View file


Open in desktop


This file was deleted.

Empty file removedmkdocs.no-insiders.yml

View file


Open in desktop


Empty file.


8 changes: 7 additions & 1 deletion
mkdocs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
INHERIT: ./mkdocs.maybe-insiders.yml
INHERIT: ./mkdocs.env.yml
site_name: SQLModel
site_description: SQLModel, SQL databases in Python, designed for simplicity, compatibility, and robustness.
site_url: https://sqlmodel.tiangolo.com/
Expand DownExpand Up@@ -58,6 +58,7 @@ plugins:
 # Material for MkDocs
 search:
 social:
 typeset:
 # Other plugins
 macros:
 include_yaml:
Expand DownExpand Up@@ -140,6 +141,11 @@ nav:
 - release-notes.md

markdown_extensions:
 # Material for MkDocs
 material.extensions.preview:
 targets:
 include:
 - "*"
 # Python Markdown
 abbr:
 attr_list:
Expand Down

3 changes: 0 additions & 3 deletions
requirements-docs-insiders.txt

View file


Open in desktop


This file was deleted.


3 changes: 2 additions & 1 deletion
requirements-docs.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,8 +10,9 @@ pyyaml >=5.3.1,<7.0.0
pillow==11.3.0
# For image processing by Material for MkDocs
cairosvg==2.8.2
# mkdocstrings[python]==0.25.1
mkdocstrings[python]==0.30.1
griffe-typingdoc==0.3.0
griffe-warnings-deprecated==1.1.0
# For griffe, it formats with black
typer == 0.20.0
mkdocs-macros-plugin==1.5.0
Expand Down

16 changes: 1 addition & 15 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,9 +2,7 @@
import os
import re
import subprocess
from functools import lru_cache
from http.server import HTTPServer, SimpleHTTPRequestHandler
from importlib import metadata
from pathlib import Path

import mkdocs.utils
Expand All@@ -19,17 +17,9 @@
app = typer.Typer()


@lru_cache
def is_mkdocs_insiders() -> bool:
 version = metadata.version("mkdocs-material")
 return "insiders" in version


@app.callback()
def callback() -> None:
 if is_mkdocs_insiders():
 os.environ["INSIDERS_FILE"] = "./mkdocs.insiders.yml"
 # For MacOS with insiders and Cairo
 # For MacOS with Cairo
 os.environ["DYLD_FALLBACK_LIBRARY_PATH"] = "/opt/homebrew/lib"


Expand DownExpand Up@@ -126,10 +116,6 @@ def build() -> None:
 """
 Build the docs.
 """
 insiders_env_file = os.environ.get("INSIDERS_FILE")
 print(f"Insiders file {insiders_env_file}")
 if is_mkdocs_insiders():
 print("Using insiders")
 print("Building docs")
 subprocess.run(["mkdocs", "build"], check=True)
 typer.secho("Successfully built docs", color=typer.colors.GREEN)
Expand Down
Loading

, '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
🔧 Upgrade Material for MkDocs and remove insiders#1650

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.

 Sign up for GitHub

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

 Merged

tiangolo
merged 1 commit into

from

Nov 20, 2025
 Merged


🔧 Upgrade Material for MkDocs and remove insiders
#1650
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 1 addition & 9 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,12 +33,9 @@ jobs:
 - docs/**
 - docs_src/**
 - requirements-docs.txt
 - requirements-docs-insiders.txt
 - pyproject.toml
 - mkdocs.yml
 - mkdocs.insiders.yml
 - mkdocs.maybe-insiders.yml
 - mkdocs.no-insiders.yml
 - mkdocs.env.yml
 - .github/workflows/build-docs.yml
 - .github/workflows/deploy-docs.yml
 - data/**
Expand DownExpand Up@@ -68,11 +65,6 @@ jobs:
 pyproject.toml
 - name: Install docs extras
 run: uv pip install -r requirements-docs.txt
 - name: Install Material for MkDocs Insiders
 if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' )
 run: uv pip install -r requirements-docs-insiders.txt
 env:
 TOKEN: ${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}
 - uses: actions/cache@v4
 with:
 key: mkdocs-cards-${{ github.ref }}
Expand Down

1 change: 0 additions & 1 deletion
mkdocs.maybe-insiders.yml → mkdocs.env.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
# Define this here and not in the main mkdocs.yml file because that one could be auto
# updated and written, and the script would remove the env var
INHERIT: !ENV [INSIDERS_FILE, './mkdocs.no-insiders.yml']
markdown_extensions:
 pymdownx.highlight:
 linenums: !ENV [LINENUMS, false]

7 changes: 0 additions & 7 deletions
mkdocs.insiders.yml

View file


Open in desktop


This file was deleted.

Empty file removedmkdocs.no-insiders.yml

View file


Open in desktop


Empty file.


8 changes: 7 additions & 1 deletion
mkdocs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
INHERIT: ./mkdocs.maybe-insiders.yml
INHERIT: ./mkdocs.env.yml
site_name: SQLModel
site_description: SQLModel, SQL databases in Python, designed for simplicity, compatibility, and robustness.
site_url: https://sqlmodel.tiangolo.com/
Expand DownExpand Up@@ -58,6 +58,7 @@ plugins:
 # Material for MkDocs
 search:
 social:
 typeset:
 # Other plugins
 macros:
 include_yaml:
Expand DownExpand Up@@ -140,6 +141,11 @@ nav:
 - release-notes.md

markdown_extensions:
 # Material for MkDocs
 material.extensions.preview:
 targets:
 include:
 - "*"
 # Python Markdown
 abbr:
 attr_list:
Expand Down

3 changes: 0 additions & 3 deletions
requirements-docs-insiders.txt

View file


Open in desktop


This file was deleted.


3 changes: 2 additions & 1 deletion
requirements-docs.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,8 +10,9 @@ pyyaml >=5.3.1,<7.0.0
pillow==11.3.0
# For image processing by Material for MkDocs
cairosvg==2.8.2
# mkdocstrings[python]==0.25.1
mkdocstrings[python]==0.30.1
griffe-typingdoc==0.3.0
griffe-warnings-deprecated==1.1.0
# For griffe, it formats with black
typer == 0.20.0
mkdocs-macros-plugin==1.5.0
Expand Down

16 changes: 1 addition & 15 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,9 +2,7 @@
import os
import re
import subprocess
from functools import lru_cache
from http.server import HTTPServer, SimpleHTTPRequestHandler
from importlib import metadata
from pathlib import Path

import mkdocs.utils
Expand All@@ -19,17 +17,9 @@
app = typer.Typer()


@lru_cache
def is_mkdocs_insiders() -> bool:
 version = metadata.version("mkdocs-material")
 return "insiders" in version


@app.callback()
def callback() -> None:
 if is_mkdocs_insiders():
 os.environ["INSIDERS_FILE"] = "./mkdocs.insiders.yml"
 # For MacOS with insiders and Cairo
 # For MacOS with Cairo
 os.environ["DYLD_FALLBACK_LIBRARY_PATH"] = "/opt/homebrew/lib"


Expand DownExpand Up@@ -126,10 +116,6 @@ def build() -> None:
 """
 Build the docs.
 """
 insiders_env_file = os.environ.get("INSIDERS_FILE")
 print(f"Insiders file {insiders_env_file}")
 if is_mkdocs_insiders():
 print("Using insiders")
 print("Building docs")
 subprocess.run(["mkdocs", "build"], check=True)
 typer.secho("Successfully built docs", color=typer.colors.GREEN)
Expand Down
Loading

, '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
🔧 Upgrade Material for MkDocs and remove insiders#1650

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.

 Sign up for GitHub

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

 Merged

tiangolo
merged 1 commit into

from

Nov 20, 2025
 Merged


🔧 Upgrade Material for MkDocs and remove insiders
#1650
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 1 addition & 9 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,12 +33,9 @@ jobs:
 - docs/**
 - docs_src/**
 - requirements-docs.txt
 - requirements-docs-insiders.txt
 - pyproject.toml
 - mkdocs.yml
 - mkdocs.insiders.yml
 - mkdocs.maybe-insiders.yml
 - mkdocs.no-insiders.yml
 - mkdocs.env.yml
 - .github/workflows/build-docs.yml
 - .github/workflows/deploy-docs.yml
 - data/**
Expand DownExpand Up@@ -68,11 +65,6 @@ jobs:
 pyproject.toml
 - name: Install docs extras
 run: uv pip install -r requirements-docs.txt
 - name: Install Material for MkDocs Insiders
 if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' )
 run: uv pip install -r requirements-docs-insiders.txt
 env:
 TOKEN: ${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}
 - uses: actions/cache@v4
 with:
 key: mkdocs-cards-${{ github.ref }}
Expand Down

1 change: 0 additions & 1 deletion
mkdocs.maybe-insiders.yml → mkdocs.env.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
# Define this here and not in the main mkdocs.yml file because that one could be auto
# updated and written, and the script would remove the env var
INHERIT: !ENV [INSIDERS_FILE, './mkdocs.no-insiders.yml']
markdown_extensions:
 pymdownx.highlight:
 linenums: !ENV [LINENUMS, false]

7 changes: 0 additions & 7 deletions
mkdocs.insiders.yml

View file


Open in desktop


This file was deleted.

Empty file removedmkdocs.no-insiders.yml

View file


Open in desktop


Empty file.


8 changes: 7 additions & 1 deletion
mkdocs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
INHERIT: ./mkdocs.maybe-insiders.yml
INHERIT: ./mkdocs.env.yml
site_name: SQLModel
site_description: SQLModel, SQL databases in Python, designed for simplicity, compatibility, and robustness.
site_url: https://sqlmodel.tiangolo.com/
Expand DownExpand Up@@ -58,6 +58,7 @@ plugins:
 # Material for MkDocs
 search:
 social:
 typeset:
 # Other plugins
 macros:
 include_yaml:
Expand DownExpand Up@@ -140,6 +141,11 @@ nav:
 - release-notes.md

markdown_extensions:
 # Material for MkDocs
 material.extensions.preview:
 targets:
 include:
 - "*"
 # Python Markdown
 abbr:
 attr_list:
Expand Down

3 changes: 0 additions & 3 deletions
requirements-docs-insiders.txt

View file


Open in desktop


This file was deleted.


3 changes: 2 additions & 1 deletion
requirements-docs.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,8 +10,9 @@ pyyaml >=5.3.1,<7.0.0
pillow==11.3.0
# For image processing by Material for MkDocs
cairosvg==2.8.2
# mkdocstrings[python]==0.25.1
mkdocstrings[python]==0.30.1
griffe-typingdoc==0.3.0
griffe-warnings-deprecated==1.1.0
# For griffe, it formats with black
typer == 0.20.0
mkdocs-macros-plugin==1.5.0
Expand Down

16 changes: 1 addition & 15 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,9 +2,7 @@
import os
import re
import subprocess
from functools import lru_cache
from http.server import HTTPServer, SimpleHTTPRequestHandler
from importlib import metadata
from pathlib import Path

import mkdocs.utils
Expand All@@ -19,17 +17,9 @@
app = typer.Typer()


@lru_cache
def is_mkdocs_insiders() -> bool:
 version = metadata.version("mkdocs-material")
 return "insiders" in version


@app.callback()
def callback() -> None:
 if is_mkdocs_insiders():
 os.environ["INSIDERS_FILE"] = "./mkdocs.insiders.yml"
 # For MacOS with insiders and Cairo
 # For MacOS with Cairo
 os.environ["DYLD_FALLBACK_LIBRARY_PATH"] = "/opt/homebrew/lib"


Expand DownExpand Up@@ -126,10 +116,6 @@ def build() -> None:
 """
 Build the docs.
 """
 insiders_env_file = os.environ.get("INSIDERS_FILE")
 print(f"Insiders file {insiders_env_file}")
 if is_mkdocs_insiders():
 print("Using insiders")
 print("Building docs")
 subprocess.run(["mkdocs", "build"], check=True)
 typer.secho("Successfully built docs", color=typer.colors.GREEN)
Expand Down
Loading

, '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
🔧 Upgrade Material for MkDocs and remove insiders#1650

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.

 Sign up for GitHub

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

 Merged

tiangolo
merged 1 commit into

from

Nov 20, 2025
 Merged


🔧 Upgrade Material for MkDocs and remove insiders
#1650
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 1 addition & 9 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,12 +33,9 @@ jobs:
 - docs/**
 - docs_src/**
 - requirements-docs.txt
 - requirements-docs-insiders.txt
 - pyproject.toml
 - mkdocs.yml
 - mkdocs.insiders.yml
 - mkdocs.maybe-insiders.yml
 - mkdocs.no-insiders.yml
 - mkdocs.env.yml
 - .github/workflows/build-docs.yml
 - .github/workflows/deploy-docs.yml
 - data/**
Expand DownExpand Up@@ -68,11 +65,6 @@ jobs:
 pyproject.toml
 - name: Install docs extras
 run: uv pip install -r requirements-docs.txt
 - name: Install Material for MkDocs Insiders
 if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' )
 run: uv pip install -r requirements-docs-insiders.txt
 env:
 TOKEN: ${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}
 - uses: actions/cache@v4
 with:
 key: mkdocs-cards-${{ github.ref }}
Expand Down

1 change: 0 additions & 1 deletion
mkdocs.maybe-insiders.yml → mkdocs.env.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
# Define this here and not in the main mkdocs.yml file because that one could be auto
# updated and written, and the script would remove the env var
INHERIT: !ENV [INSIDERS_FILE, './mkdocs.no-insiders.yml']
markdown_extensions:
 pymdownx.highlight:
 linenums: !ENV [LINENUMS, false]

7 changes: 0 additions & 7 deletions
mkdocs.insiders.yml

View file


Open in desktop


This file was deleted.

Empty file removedmkdocs.no-insiders.yml

View file


Open in desktop


Empty file.


8 changes: 7 additions & 1 deletion
mkdocs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
INHERIT: ./mkdocs.maybe-insiders.yml
INHERIT: ./mkdocs.env.yml
site_name: SQLModel
site_description: SQLModel, SQL databases in Python, designed for simplicity, compatibility, and robustness.
site_url: https://sqlmodel.tiangolo.com/
Expand DownExpand Up@@ -58,6 +58,7 @@ plugins:
 # Material for MkDocs
 search:
 social:
 typeset:
 # Other plugins
 macros:
 include_yaml:
Expand DownExpand Up@@ -140,6 +141,11 @@ nav:
 - release-notes.md

markdown_extensions:
 # Material for MkDocs
 material.extensions.preview:
 targets:
 include:
 - "*"
 # Python Markdown
 abbr:
 attr_list:
Expand Down

3 changes: 0 additions & 3 deletions
requirements-docs-insiders.txt

View file


Open in desktop


This file was deleted.


3 changes: 2 additions & 1 deletion
requirements-docs.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,8 +10,9 @@ pyyaml >=5.3.1,<7.0.0
pillow==11.3.0
# For image processing by Material for MkDocs
cairosvg==2.8.2
# mkdocstrings[python]==0.25.1
mkdocstrings[python]==0.30.1
griffe-typingdoc==0.3.0
griffe-warnings-deprecated==1.1.0
# For griffe, it formats with black
typer == 0.20.0
mkdocs-macros-plugin==1.5.0
Expand Down

16 changes: 1 addition & 15 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,9 +2,7 @@
import os
import re
import subprocess
from functools import lru_cache
from http.server import HTTPServer, SimpleHTTPRequestHandler
from importlib import metadata
from pathlib import Path

import mkdocs.utils
Expand All@@ -19,17 +17,9 @@
app = typer.Typer()


@lru_cache
def is_mkdocs_insiders() -> bool:
 version = metadata.version("mkdocs-material")
 return "insiders" in version


@app.callback()
def callback() -> None:
 if is_mkdocs_insiders():
 os.environ["INSIDERS_FILE"] = "./mkdocs.insiders.yml"
 # For MacOS with insiders and Cairo
 # For MacOS with Cairo
 os.environ["DYLD_FALLBACK_LIBRARY_PATH"] = "/opt/homebrew/lib"


Expand DownExpand Up@@ -126,10 +116,6 @@ def build() -> None:
 """
 Build the docs.
 """
 insiders_env_file = os.environ.get("INSIDERS_FILE")
 print(f"Insiders file {insiders_env_file}")
 if is_mkdocs_insiders():
 print("Using insiders")
 print("Building docs")
 subprocess.run(["mkdocs", "build"], check=True)
 typer.secho("Successfully built docs", color=typer.colors.GREEN)
Expand Down
Loading

, '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
🔧 Upgrade Material for MkDocs and remove insiders#1650

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.

 Sign up for GitHub

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

 Merged

tiangolo
merged 1 commit into

from

Nov 20, 2025
 Merged


🔧 Upgrade Material for MkDocs and remove insiders
#1650
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 1 addition & 9 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,12 +33,9 @@ jobs:
 - docs/**
 - docs_src/**
 - requirements-docs.txt
 - requirements-docs-insiders.txt
 - pyproject.toml
 - mkdocs.yml
 - mkdocs.insiders.yml
 - mkdocs.maybe-insiders.yml
 - mkdocs.no-insiders.yml
 - mkdocs.env.yml
 - .github/workflows/build-docs.yml
 - .github/workflows/deploy-docs.yml
 - data/**
Expand DownExpand Up@@ -68,11 +65,6 @@ jobs:
 pyproject.toml
 - name: Install docs extras
 run: uv pip install -r requirements-docs.txt
 - name: Install Material for MkDocs Insiders
 if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' )
 run: uv pip install -r requirements-docs-insiders.txt
 env:
 TOKEN: ${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}
 - uses: actions/cache@v4
 with:
 key: mkdocs-cards-${{ github.ref }}
Expand Down

1 change: 0 additions & 1 deletion
mkdocs.maybe-insiders.yml → mkdocs.env.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
# Define this here and not in the main mkdocs.yml file because that one could be auto
# updated and written, and the script would remove the env var
INHERIT: !ENV [INSIDERS_FILE, './mkdocs.no-insiders.yml']
markdown_extensions:
 pymdownx.highlight:
 linenums: !ENV [LINENUMS, false]

7 changes: 0 additions & 7 deletions
mkdocs.insiders.yml

View file


Open in desktop


This file was deleted.

Empty file removedmkdocs.no-insiders.yml

View file


Open in desktop


Empty file.


8 changes: 7 additions & 1 deletion
mkdocs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
INHERIT: ./mkdocs.maybe-insiders.yml
INHERIT: ./mkdocs.env.yml
site_name: SQLModel
site_description: SQLModel, SQL databases in Python, designed for simplicity, compatibility, and robustness.
site_url: https://sqlmodel.tiangolo.com/
Expand DownExpand Up@@ -58,6 +58,7 @@ plugins:
 # Material for MkDocs
 search:
 social:
 typeset:
 # Other plugins
 macros:
 include_yaml:
Expand DownExpand Up@@ -140,6 +141,11 @@ nav:
 - release-notes.md

markdown_extensions:
 # Material for MkDocs
 material.extensions.preview:
 targets:
 include:
 - "*"
 # Python Markdown
 abbr:
 attr_list:
Expand Down

3 changes: 0 additions & 3 deletions
requirements-docs-insiders.txt

View file


Open in desktop


This file was deleted.


3 changes: 2 additions & 1 deletion
requirements-docs.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,8 +10,9 @@ pyyaml >=5.3.1,<7.0.0
pillow==11.3.0
# For image processing by Material for MkDocs
cairosvg==2.8.2
# mkdocstrings[python]==0.25.1
mkdocstrings[python]==0.30.1
griffe-typingdoc==0.3.0
griffe-warnings-deprecated==1.1.0
# For griffe, it formats with black
typer == 0.20.0
mkdocs-macros-plugin==1.5.0
Expand Down

16 changes: 1 addition & 15 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,9 +2,7 @@
import os
import re
import subprocess
from functools import lru_cache
from http.server import HTTPServer, SimpleHTTPRequestHandler
from importlib import metadata
from pathlib import Path

import mkdocs.utils
Expand All@@ -19,17 +17,9 @@
app = typer.Typer()


@lru_cache
def is_mkdocs_insiders() -> bool:
 version = metadata.version("mkdocs-material")
 return "insiders" in version


@app.callback()
def callback() -> None:
 if is_mkdocs_insiders():
 os.environ["INSIDERS_FILE"] = "./mkdocs.insiders.yml"
 # For MacOS with insiders and Cairo
 # For MacOS with Cairo
 os.environ["DYLD_FALLBACK_LIBRARY_PATH"] = "/opt/homebrew/lib"


Expand DownExpand Up@@ -126,10 +116,6 @@ def build() -> None:
 """
 Build the docs.
 """
 insiders_env_file = os.environ.get("INSIDERS_FILE")
 print(f"Insiders file {insiders_env_file}")
 if is_mkdocs_insiders():
 print("Using insiders")
 print("Building docs")
 subprocess.run(["mkdocs", "build"], check=True)
 typer.secho("Successfully built docs", color=typer.colors.GREEN)
Expand Down
Loading

, '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
🔧 Upgrade Material for MkDocs and remove insiders#1650

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.

 Sign up for GitHub

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

 Merged

tiangolo
merged 1 commit into

from

Nov 20, 2025
 Merged


🔧 Upgrade Material for MkDocs and remove insiders
#1650
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 1 addition & 9 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,12 +33,9 @@ jobs:
 - docs/**
 - docs_src/**
 - requirements-docs.txt
 - requirements-docs-insiders.txt
 - pyproject.toml
 - mkdocs.yml
 - mkdocs.insiders.yml
 - mkdocs.maybe-insiders.yml
 - mkdocs.no-insiders.yml
 - mkdocs.env.yml
 - .github/workflows/build-docs.yml
 - .github/workflows/deploy-docs.yml
 - data/**
Expand DownExpand Up@@ -68,11 +65,6 @@ jobs:
 pyproject.toml
 - name: Install docs extras
 run: uv pip install -r requirements-docs.txt
 - name: Install Material for MkDocs Insiders
 if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' )
 run: uv pip install -r requirements-docs-insiders.txt
 env:
 TOKEN: ${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}
 - uses: actions/cache@v4
 with:
 key: mkdocs-cards-${{ github.ref }}
Expand Down

1 change: 0 additions & 1 deletion
mkdocs.maybe-insiders.yml → mkdocs.env.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
# Define this here and not in the main mkdocs.yml file because that one could be auto
# updated and written, and the script would remove the env var
INHERIT: !ENV [INSIDERS_FILE, './mkdocs.no-insiders.yml']
markdown_extensions:
 pymdownx.highlight:
 linenums: !ENV [LINENUMS, false]

7 changes: 0 additions & 7 deletions
mkdocs.insiders.yml

View file


Open in desktop


This file was deleted.

Empty file removedmkdocs.no-insiders.yml

View file


Open in desktop


Empty file.


8 changes: 7 additions & 1 deletion
mkdocs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
INHERIT: ./mkdocs.maybe-insiders.yml
INHERIT: ./mkdocs.env.yml
site_name: SQLModel
site_description: SQLModel, SQL databases in Python, designed for simplicity, compatibility, and robustness.
site_url: https://sqlmodel.tiangolo.com/
Expand DownExpand Up@@ -58,6 +58,7 @@ plugins:
 # Material for MkDocs
 search:
 social:
 typeset:
 # Other plugins
 macros:
 include_yaml:
Expand DownExpand Up@@ -140,6 +141,11 @@ nav:
 - release-notes.md

markdown_extensions:
 # Material for MkDocs
 material.extensions.preview:
 targets:
 include:
 - "*"
 # Python Markdown
 abbr:
 attr_list:
Expand Down

3 changes: 0 additions & 3 deletions
requirements-docs-insiders.txt

View file


Open in desktop


This file was deleted.


3 changes: 2 additions & 1 deletion
requirements-docs.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,8 +10,9 @@ pyyaml >=5.3.1,<7.0.0
pillow==11.3.0
# For image processing by Material for MkDocs
cairosvg==2.8.2
# mkdocstrings[python]==0.25.1
mkdocstrings[python]==0.30.1
griffe-typingdoc==0.3.0
griffe-warnings-deprecated==1.1.0
# For griffe, it formats with black
typer == 0.20.0
mkdocs-macros-plugin==1.5.0
Expand Down

16 changes: 1 addition & 15 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,9 +2,7 @@
import os
import re
import subprocess
from functools import lru_cache
from http.server import HTTPServer, SimpleHTTPRequestHandler
from importlib import metadata
from pathlib import Path

import mkdocs.utils
Expand All@@ -19,17 +17,9 @@
app = typer.Typer()


@lru_cache
def is_mkdocs_insiders() -> bool:
 version = metadata.version("mkdocs-material")
 return "insiders" in version


@app.callback()
def callback() -> None:
 if is_mkdocs_insiders():
 os.environ["INSIDERS_FILE"] = "./mkdocs.insiders.yml"
 # For MacOS with insiders and Cairo
 # For MacOS with Cairo
 os.environ["DYLD_FALLBACK_LIBRARY_PATH"] = "/opt/homebrew/lib"


Expand DownExpand Up@@ -126,10 +116,6 @@ def build() -> None:
 """
 Build the docs.
 """
 insiders_env_file = os.environ.get("INSIDERS_FILE")
 print(f"Insiders file {insiders_env_file}")
 if is_mkdocs_insiders():
 print("Using insiders")
 print("Building docs")
 subprocess.run(["mkdocs", "build"], check=True)
 typer.secho("Successfully built docs", color=typer.colors.GREEN)
Expand Down
Loading

, '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
🔧 Upgrade Material for MkDocs and remove insiders#1650

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.

 Sign up for GitHub

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

 Merged

tiangolo
merged 1 commit into

from

Nov 20, 2025
 Merged


🔧 Upgrade Material for MkDocs and remove insiders
#1650
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 1 addition & 9 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,12 +33,9 @@ jobs:
 - docs/**
 - docs_src/**
 - requirements-docs.txt
 - requirements-docs-insiders.txt
 - pyproject.toml
 - mkdocs.yml
 - mkdocs.insiders.yml
 - mkdocs.maybe-insiders.yml
 - mkdocs.no-insiders.yml
 - mkdocs.env.yml
 - .github/workflows/build-docs.yml
 - .github/workflows/deploy-docs.yml
 - data/**
Expand DownExpand Up@@ -68,11 +65,6 @@ jobs:
 pyproject.toml
 - name: Install docs extras
 run: uv pip install -r requirements-docs.txt
 - name: Install Material for MkDocs Insiders
 if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' )
 run: uv pip install -r requirements-docs-insiders.txt
 env:
 TOKEN: ${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}
 - uses: actions/cache@v4
 with:
 key: mkdocs-cards-${{ github.ref }}
Expand Down

1 change: 0 additions & 1 deletion
mkdocs.maybe-insiders.yml → mkdocs.env.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
# Define this here and not in the main mkdocs.yml file because that one could be auto
# updated and written, and the script would remove the env var
INHERIT: !ENV [INSIDERS_FILE, './mkdocs.no-insiders.yml']
markdown_extensions:
 pymdownx.highlight:
 linenums: !ENV [LINENUMS, false]

7 changes: 0 additions & 7 deletions
mkdocs.insiders.yml

View file


Open in desktop


This file was deleted.

Empty file removedmkdocs.no-insiders.yml

View file


Open in desktop


Empty file.


8 changes: 7 additions & 1 deletion
mkdocs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
INHERIT: ./mkdocs.maybe-insiders.yml
INHERIT: ./mkdocs.env.yml
site_name: SQLModel
site_description: SQLModel, SQL databases in Python, designed for simplicity, compatibility, and robustness.
site_url: https://sqlmodel.tiangolo.com/
Expand DownExpand Up@@ -58,6 +58,7 @@ plugins:
 # Material for MkDocs
 search:
 social:
 typeset:
 # Other plugins
 macros:
 include_yaml:
Expand DownExpand Up@@ -140,6 +141,11 @@ nav:
 - release-notes.md

markdown_extensions:
 # Material for MkDocs
 material.extensions.preview:
 targets:
 include:
 - "*"
 # Python Markdown
 abbr:
 attr_list:
Expand Down

3 changes: 0 additions & 3 deletions
requirements-docs-insiders.txt

View file


Open in desktop


This file was deleted.


3 changes: 2 additions & 1 deletion
requirements-docs.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,8 +10,9 @@ pyyaml >=5.3.1,<7.0.0
pillow==11.3.0
# For image processing by Material for MkDocs
cairosvg==2.8.2
# mkdocstrings[python]==0.25.1
mkdocstrings[python]==0.30.1
griffe-typingdoc==0.3.0
griffe-warnings-deprecated==1.1.0
# For griffe, it formats with black
typer == 0.20.0
mkdocs-macros-plugin==1.5.0
Expand Down

16 changes: 1 addition & 15 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,9 +2,7 @@
import os
import re
import subprocess
from functools import lru_cache
from http.server import HTTPServer, SimpleHTTPRequestHandler
from importlib import metadata
from pathlib import Path

import mkdocs.utils
Expand All@@ -19,17 +17,9 @@
app = typer.Typer()


@lru_cache
def is_mkdocs_insiders() -> bool:
 version = metadata.version("mkdocs-material")
 return "insiders" in version


@app.callback()
def callback() -> None:
 if is_mkdocs_insiders():
 os.environ["INSIDERS_FILE"] = "./mkdocs.insiders.yml"
 # For MacOS with insiders and Cairo
 # For MacOS with Cairo
 os.environ["DYLD_FALLBACK_LIBRARY_PATH"] = "/opt/homebrew/lib"


Expand DownExpand Up@@ -126,10 +116,6 @@ def build() -> None:
 """
 Build the docs.
 """
 insiders_env_file = os.environ.get("INSIDERS_FILE")
 print(f"Insiders file {insiders_env_file}")
 if is_mkdocs_insiders():
 print("Using insiders")
 print("Building docs")
 subprocess.run(["mkdocs", "build"], check=True)
 typer.secho("Successfully built docs", color=typer.colors.GREEN)
Expand Down
Loading