gador/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

pkgs/nixos-render-docs: introduce sidebar navigation (#532914)

Browse Source
This commit is contained in:
Johannes Kirschbauer
2026-06-23 10:11:25 +00:00
committed by GitHub
parent 9d612b6851 f51d8dfb42
commit 67d8ee19ea
2 changed files with 73 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/style.css
+68 -3
View File
@@ -34,7 +34,7 @@ body {
}
}
.book .list-of-examples {
.list-of-examples {
display: none;
}
@@ -392,8 +392,7 @@ div.appendix .toc dt {
margin-top: 0;
}
div.book .list-of-examples dt,
div.appendix .list-of-examples dt {
.list-of-examples dt {
margin-top: 0;
}
@@ -450,6 +449,7 @@ div.appendix .variablelist .term {
}
:root {
--sidebar-width: 20rem;
--background: #fff;
--main-text-color: #000;
--link-color: #405d99;
@@ -496,3 +496,68 @@ div.appendix .variablelist .term {
.chapter {
content-visibility: auto;
}
.navheader {
position: sticky;
top: 0;
z-index: 1;
background-color: var(--background);
}
nav.toc-sidebar {
height: 100%;
overflow-y: none;
padding: 0 1rem 2rem;
border-bottom: 0.0625rem solid #d8d8d8;
}
nav.toc-sidebar .toc {
margin-bottom: 0;
}
nav.toc-sidebar .toc dl {
margin: 0;
}
nav.toc-sidebar .toc dd {
margin-left: 1em;
}
@media screen and (min-width: 768px) {
body {
height: 100vh;
min-height: 0;
display: grid;
grid-template-columns: minmax(0, 1fr);
grid-template-rows: auto minmax(0, 1fr);
}
body:has(> nav.toc-sidebar) {
grid-template-columns: var(--sidebar-width) minmax(0, 1fr);
}
.navheader {
grid-column: 1 / -1;
grid-row: 1;
}
nav.toc-sidebar {
grid-column: 1;
grid-row: 2;
max-height: none;
overflow-y: auto;
border-bottom: none;
border-right: 0.0625rem solid #d8d8d8;
}
main.content {
grid-column: 1 / -1;
grid-row: 2;
overflow-y: auto;
padding: 0 1rem;
}
body:has(> nav.toc-sidebar) main.content {
grid-column: 2;
}
}
pkgs/by-name/ni/nixos-render-docs/src/nixos_render_docs/manual.py
+5 -3
View File
@@ -307,7 +307,7 @@ class ManualHTMLRenderer(RendererMixin, HTMLRenderer):
toc = TocEntry.of(tokens[0])
return "\n".join([
self._file_header(toc),
self._file_header(toc, sidebar=self._build_toc(tokens, 0)),
' <div class="book">',
' <div class="titlepage">',
' <div>',
@@ -316,13 +316,12 @@ class ManualHTMLRenderer(RendererMixin, HTMLRenderer):
' </div>',
" <hr />",
' </div>',
self._build_toc(tokens, 0),
super(HTMLRenderer, self).render(tokens[6:]),
' </div>',
self._file_footer(toc),
])
def _file_header(self, toc: TocEntry) -> str:
def _file_header(self, toc: TocEntry, sidebar: str = "") -> str:
prev_link, up_link, next_link = "", "", ""
prev_a, next_a, parent_title = "", "", "&nbsp;"
nav_html = ""
@@ -384,6 +383,8 @@ class ManualHTMLRenderer(RendererMixin, HTMLRenderer):
' </head>',
' <body>',
nav_html,
f' <nav class="toc-sidebar">{sidebar}</nav>' if sidebar else "",
' <main class="content">',
])
def _file_footer(self, toc: TocEntry) -> str:
@@ -424,6 +425,7 @@ class ManualHTMLRenderer(RendererMixin, HTMLRenderer):
])
return "\n".join([
nav_html,
' </main>',
' </body>',
'</html>',
])