Skip to content

Commit 4e7d50f

Browse files
Tygo-van-den-HurkTygo-van-den-Hurk
committed
docs: add darkreader meta tag
This makes DarkReader respect dark mode on the page as that is set to auto.
1 parent 50eb55d commit 4e7d50f

File tree

4 files changed

+122
-2
lines changed

4 files changed

+122
-2
lines changed

‎.github/workflows/many--prevent-dead-links.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ jobs:
4343
args: >
4444
--glob-ignore-case **/*.{md,markdown,html,htm}
4545
--verbose --max-concurrency 1 --hidden --cache
46-
--max-cache-age 1d
46+
--max-cache-age 1d --exclude-path docs/overrides
4747
- name: Save lychee cache
4848
uses: actions/cache/save@v5.0.1
4949
with:

‎.github/workflows/push--deploy-github-pages.yaml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,9 @@ jobs:
4444
token: ${{ secrets.GITHUB_TOKEN }}
4545
args: >
4646
docs --no-progress --hidden --verbose
47+
--exclude-path docs/overrides
4748
--cache --max-cache-age 1d
48-
--max-concurrency 1
49+
--max-concurrency 1
4950
- name: Save lychee cache
5051
uses: actions/cache/save@v5.0.1
5152
with:

‎docs/overrides/main.html‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<script>
5+
// for search plugin notably
6+
const base_url = "{{ config.site_url }}";
7+
</script>
8+
{% include "templates/dark.html" %}
9+
10+
<meta name="darkreader-lock">
11+
12+
<meta charset="UTF-8">
13+
<meta name="viewport" content="width=device-width, initial-scale=1">
14+
15+
<title>{% if page.title %}{{ page.title }} - {% endif %}{{ config.site_name }}</title>
16+
{% include "templates/seo.html" %}
17+
18+
{%- if config.theme.favicon %}
19+
<link rel="icon" href="{{ config.theme.favicon | url }}">
20+
{%- else %}
21+
<link rel="icon" href="{{ 'img/favicon.ico' | url }}">
22+
{%- endif %}
23+
24+
<link href="{{ 'css/base.css' | url }}" rel="stylesheet">
25+
<link href="{{ 'css/geist.css' | url }}" rel="stylesheet">
26+
27+
{% if "codehilite" in config.markdown_extensions %}
28+
{% include "templates/pygments.html" %}
29+
{% endif %}
30+
31+
{%- for path in config.extra_css %}
32+
<link href="{{ path | url }}" rel="stylesheet">
33+
{%- endfor %}
34+
35+
{% if page.meta.extra_css %}
36+
{%- for path in page.meta.extra_css %}
37+
<link href="{{ path | url }}" rel="stylesheet">
38+
{%- endfor %}
39+
{% endif %}
40+
41+
<script src="{{ 'js/callbacks.js' | url }}"></script>
42+
43+
{% if "pymdownx.arithmatex" in config.markdown_extensions %}
44+
{% include "templates/katex.html" %}
45+
{% endif %}
46+
47+
{% if "shadcn.extensions.echarts.alpha" in config.markdown_extensions %}
48+
{% include "templates/echarts.html" %}
49+
{% endif %}
50+
51+
{% if "shadcn/excalidraw" in config.plugins and is_dev_server %}
52+
{% include "templates/excalidraw.html" %}
53+
{% endif %}
54+
55+
</head>
56+
57+
<body
58+
class="text-foreground group/body overscroll-none font-sans antialiased [--footer-height:calc(var(--spacing)*14)] [--header-height:calc(var(--spacing)*14)] xl:[--footer-height:calc(var(--spacing)*24)] theme-default">
59+
<div id="inner-body" class="bg-background relative z-10 flex min-h-svh flex-col">
60+
{% include "templates/header.html" %}
61+
<main class="flex flex-1 flex-col">
62+
<div class="container-wrapper flex flex-1 flex-col px-2">
63+
<div data-slot="sidebar-wrapper" style="--sidebar-width: 16rem; --sidebar-width-icon: 3rem;"
64+
class="group/sidebar-wrapper has-data-[variant=inset]:bg-sidebar flex w-full 3xl:fixed:container 3xl:fixed:px-3 min-h-min flex-1 items-start px-0 [--sidebar-width:220px] [--top-spacing:0] lg:grid lg:grid-cols-[var(--sidebar-width)_minmax(0,1fr)] lg:[--sidebar-width:240px] lg:[--top-spacing:calc(var(--spacing)*4)]">
65+
<div data-slot="sidebar"
66+
class="text-sidebar-foreground w-(--sidebar-width) flex-col sticky top-[calc(var(--header-height)+1px)] z-30 hidden h-[calc(100svh-var(--header-height)-var(--footer-height))] bg-transparent lg:flex">
67+
<div data-slot="sidebar-content" data-sidebar="content"
68+
class="flex min-h-0 flex-1 flex-col gap-2 overflow-auto group-data-[collapsible=icon]:overflow-hidden no-scrollbar px-2 pb-12">
69+
<div class="h-(--top-spacing) shrink-0"></div>
70+
{% include "templates/sidebar.html" %}
71+
</div>
72+
</div>
73+
<div class="h-full w-full">
74+
<div data-slot="docs" class="flex items-stretch text-[1.05rem] sm:text-[15px] xl:w-full">
75+
<div class="flex min-w-0 flex-1 flex-col">
76+
<div class="h-(--top-spacing) shrink-0"></div>
77+
{% include "templates/page.html" %}
78+
{% include "templates/bottom_navigation.html" %}
79+
{% include "templates/bottom_sidebar.html" %}
80+
</div>
81+
<div
82+
class="sticky top-[calc(var(--header-height)+1px)] z-30 ml-auto hidden h-[calc(100svh-var(--header-height)-var(--footer-height))] w-72 flex-col gap-4 overflow-hidden overscroll-none pb-8 xl:flex">
83+
<div class="h-(--top-spacing) shrink-0"></div>
84+
{% include "templates/toc.html" %}
85+
</div>
86+
</div>
87+
</div>
88+
</div>
89+
</div>
90+
</main>
91+
{% include "templates/footer.html" %}
92+
</div>
93+
94+
95+
{%- for script in config.extra_javascript %}
96+
{% include "templates/script.html" %}
97+
{%- endfor %}
98+
99+
{% if page.meta.extra_javascript %}
100+
{%- for script in page.meta.extra_javascript %}
101+
{% include "templates/script.html" %}
102+
{%- endfor %}
103+
{% endif %}
104+
105+
<script src="{{ 'js/copy-button.js' | url }}"></script>
106+
<script>updatePygmentsStylesheet();</script>
107+
{% if config.theme.show_stargazers %}
108+
<script>fetchStargazers("{{ config.repo_url }}");</script>
109+
{% endif %}
110+
{% if "mkdocstrings" in config.plugins %}
111+
{% include "templates/mkdocstrings.html" %}
112+
{% endif %}
113+
{% if "shadcn.extensions.codexec" in config.markdown_extensions %}
114+
{% include "templates/codexec.html" %}
115+
{% endif %}
116+
{% include "templates/speculation_rules.html" %}
117+
</body>
118+
</html>

‎mkdocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ theme:
99
name: shadcn
1010
icon: assets/logo-standalone.svg
1111
favicon: assets/logo-standalone.svg
12+
custom_dir: docs/overrides
1213
show_title: true
1314
show_stargazers: false
1415
pygments_style:

0 commit comments

Comments
 (0)
⚡