echo/website
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: markdown documentation section (sidebar nav, per-page toc, search, hljs)

Browse source
This commit is contained in:
Jean Chevronnet 2026-08-30 19:20:02 +00:00
parent d1ec6962dd
commit fc129a1f1b
No known key found for this signature in database
GPG key ID: 439666D63A9477E4
16 changed files with 841 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

71
static/docs.css Normal file
View file

@ -0,0 +1,71 @@
/* Documentation layout: sidebar · content · table-of-contents. Loads on top of
style.css, so the :root custom properties defined there are available here. */
.docs-shell{
max-width:1260px;margin:0 auto;padding:0 1.25rem 3rem;
display:grid;grid-template-columns:236px minmax(0,1fr) 210px;gap:2.2rem;align-items:start;
}
/* sidebar */
.docs-side{position:sticky;top:74px;align-self:start;padding-top:1.6rem;max-height:calc(100vh - 84px);overflow-y:auto}
.docs-search{position:relative;margin-bottom:1.2rem}
.docs-search input{width:100%;padding:.5rem .7rem;border:1px solid var(--line2);border-radius:8px;font:inherit;font-size:.9rem;background:#fff;color:var(--ink)}
.docs-search input:focus{outline:none;border-color:var(--teal);box-shadow:0 0 0 3px rgba(18,165,148,.12)}
.results{position:absolute;top:calc(100% + 6px);left:0;right:-40px;background:#fff;border:1px solid var(--line);border-radius:10px;box-shadow:0 18px 40px -18px rgba(20,40,60,.4);z-index:30;max-height:70vh;overflow:auto;padding:.3rem}
.results a{display:block;padding:.5rem .6rem;border-radius:7px;color:var(--ink)}
.results a:hover{background:var(--teal-t);text-decoration:none}
.results a b{display:block;color:var(--teal-dd);font-size:.92rem}
.results a span{display:block;color:var(--muted);font-size:.8rem;font-family:var(--mono);white-space:nowrap;overflow:hidden;text-overflow:ellipsis}
.results .no-res{padding:.6rem;color:var(--faint);font-size:.88rem}
.side-sec{margin-bottom:1.3rem}
.side-h{font-size:.72rem;text-transform:uppercase;letter-spacing:.13em;color:var(--faint);font-weight:600;margin-bottom:.5rem}
.side-link{display:block;padding:.32rem .7rem;color:var(--muted);border-left:2px solid transparent;font-size:.94rem;border-radius:0 6px 6px 0}
.side-link:hover{color:var(--ink);background:#fff;text-decoration:none}
.side-link.active{color:var(--teal-dd);border-left-color:var(--teal);background:var(--teal-t);font-weight:500}
/* content */
.docs-body{padding-top:1.4rem;min-width:0;font-size:16px;line-height:1.72}
.docs-body>h1:first-child{margin-top:0}
.docs-body h1{font-size:2.05rem;letter-spacing:-.02em;margin:0 0 1rem}
.docs-body h2{font-size:1.45rem;margin:2.2rem 0 .8rem;padding-bottom:.35rem;border-bottom:1px solid var(--line)}
.docs-body h3{font-size:1.15rem;margin:1.6rem 0 .5rem}
.docs-body h2 .anchor,.docs-body h3 .anchor{margin-left:.4rem;color:var(--line2);opacity:0;font-weight:400;text-decoration:none}
.docs-body h2:hover .anchor,.docs-body h3:hover .anchor{opacity:1;color:var(--teal)}
.docs-body p{margin:0 0 1rem}
.docs-body ul,.docs-body ol{margin:0 0 1rem;padding-left:1.4rem}
.docs-body li{margin:.3rem 0}
.docs-body a{color:var(--teal-d);font-weight:500}
.docs-body code{font-family:var(--mono);font-size:.88em;background:rgba(18,165,148,.09);color:var(--teal-dd);padding:.08em .4em;border-radius:5px}
.docs-body pre{background:#f6f8fa;border:1px solid var(--line);border-radius:9px;padding:.9rem 1.1rem;overflow-x:auto;margin:0 0 1.2rem}
.docs-body pre code{background:none;color:#1f2733;padding:0;font-size:.87rem;line-height:1.65}
.docs-body table{border-collapse:collapse;width:100%;margin:0 0 1.2rem;font-size:.94rem}
.docs-body th,.docs-body td{text-align:left;padding:.5rem .8rem;border:1px solid var(--line)}
.docs-body th{background:#f7f9fa;font-weight:600}
.docs-body blockquote{margin:0 0 1.2rem;padding:.7rem 1rem;background:var(--teal-t);border-left:3px solid var(--teal);border-radius:0 8px 8px 0;color:#0c5a51}
.docs-body blockquote p:last-child{margin:0}
.docs-body hr{border:0;border-top:1px solid var(--line);margin:2rem 0}
/* prev / next */
.pager{display:flex;justify-content:space-between;gap:1rem;margin-top:2.5rem;padding-top:1.4rem;border-top:1px solid var(--line)}
.pager a{display:block;padding:.7rem 1rem;border:1px solid var(--line);border-radius:10px;min-width:44%;color:var(--ink)}
.pager a:hover{border-color:var(--teal);text-decoration:none}
.pager a span{display:block;font-size:.76rem;color:var(--faint)}
.pager a b{color:var(--teal-dd)}
.pager-next{text-align:right}
/* toc */
.docs-toc{position:sticky;top:74px;align-self:start;padding-top:1.9rem;font-size:.86rem;max-height:calc(100vh - 84px);overflow-y:auto}
.toc-h{font-size:.72rem;text-transform:uppercase;letter-spacing:.13em;color:var(--faint);font-weight:600;margin-bottom:.6rem}
.docs-toc nav{display:flex;flex-direction:column;gap:.05rem;border-left:1px solid var(--line)}
.docs-toc a{color:var(--muted);padding:.24rem .8rem;border-left:2px solid transparent;margin-left:-1px}
.docs-toc a:hover{color:var(--teal-dd);text-decoration:none;border-left-color:var(--line2)}
.docs-toc a.toc-l3{padding-left:1.5rem;font-size:.82rem}
@media(max-width:1000px){
.docs-shell{grid-template-columns:220px minmax(0,1fr)}
.docs-toc{display:none}
}
@media(max-width:720px){
.docs-shell{grid-template-columns:1fr;gap:1rem}
.docs-side{position:static;max-height:none;border-bottom:1px solid var(--line);padding-bottom:1rem}
.results{right:0}
}