Skip to content

Commit 89a33c7

Browse files
author
xiaoyunchong.xyc
committed
feat: add sticky left sidebar navigation to tutorial page
- New .doc-sidebar CSS class (reusable for other pages) - Tutorial TOC moved from top grid to sticky left panel - Mobile: collapses to horizontal scroll bar - Sections always accessible while scrolling
1 parent e6b679a commit 89a33c7

2 files changed

Lines changed: 106 additions & 10 deletions

File tree

‎style.css‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1412,3 +1412,93 @@ footer a:hover {
14121412
padding: 28px 16px;
14131413
}
14141414
}
1415+
1416+
/* Doc sidebar layout - for tutorial, training, etc */
1417+
.doc-layout {
1418+
display: flex;
1419+
gap: 0;
1420+
max-width: 1400px;
1421+
margin: 0 auto;
1422+
}
1423+
1424+
.doc-sidebar {
1425+
position: sticky;
1426+
top: 60px;
1427+
width: 240px;
1428+
min-width: 240px;
1429+
height: calc(100vh - 60px);
1430+
overflow-y: auto;
1431+
border-right: 1px solid var(--line);
1432+
background: var(--surface-2);
1433+
padding: 20px 0;
1434+
font-size: 0.84rem;
1435+
}
1436+
1437+
.doc-sidebar a {
1438+
display: block;
1439+
padding: 7px 20px;
1440+
color: var(--muted);
1441+
text-decoration: none;
1442+
border-left: 3px solid transparent;
1443+
transition: all 0.15s;
1444+
}
1445+
1446+
.doc-sidebar a:hover {
1447+
color: var(--primary);
1448+
background: rgba(37, 99, 235, 0.04);
1449+
}
1450+
1451+
.doc-sidebar a.active {
1452+
color: var(--primary);
1453+
border-left-color: var(--primary);
1454+
background: rgba(37, 99, 235, 0.06);
1455+
font-weight: 600;
1456+
}
1457+
1458+
.doc-sidebar .sb-title {
1459+
padding: 7px 20px;
1460+
font-weight: 700;
1461+
color: var(--ink);
1462+
font-size: 0.78rem;
1463+
text-transform: uppercase;
1464+
letter-spacing: 0.04em;
1465+
margin-top: 12px;
1466+
}
1467+
1468+
.doc-content {
1469+
flex: 1;
1470+
min-width: 0;
1471+
padding: 32px 40px;
1472+
max-width: 820px;
1473+
}
1474+
1475+
@media (max-width: 900px) {
1476+
.doc-layout {
1477+
flex-direction: column;
1478+
}
1479+
.doc-sidebar {
1480+
position: static;
1481+
width: 100%;
1482+
min-width: 100%;
1483+
height: auto;
1484+
border-right: none;
1485+
border-bottom: 1px solid var(--line);
1486+
display: flex;
1487+
flex-wrap: wrap;
1488+
padding: 12px;
1489+
gap: 4px;
1490+
}
1491+
.doc-sidebar a {
1492+
padding: 6px 12px;
1493+
border-left: none;
1494+
border-radius: 6px;
1495+
background: var(--surface);
1496+
border: 1px solid var(--line);
1497+
}
1498+
.doc-sidebar .sb-title {
1499+
width: 100%;
1500+
}
1501+
.doc-content {
1502+
padding: 24px;
1503+
}
1504+
}

‎tutorial.html‎

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,30 @@
2020
<a href="https://github.com/modelscope/FunASR" class="nav-github">GitHub</a>
2121
</div></nav>
2222

23-
<div class="content"><div class="container narrow">
24-
<h1>Tutorial</h1>
25-
<p>From zero to production — learn FunASR in 10 minutes.</p>
26-
27-
<div class="toc-grid">
23+
<div class="doc-layout">
24+
<nav class="doc-sidebar">
25+
<div class="sb-title">Tutorial</div>
2826
<a href="#quick">30-Second Demo</a>
2927
<a href="#install">Install</a>
3028
<a href="#choose">Choose a Model</a>
31-
<a href="#scenarios">Usage Scenarios</a>
29+
<div class="sb-title">Usage</div>
30+
<a href="#scenarios">Scenarios</a>
3231
<a href="#offline">Offline ASR</a>
3332
<a href="#streaming">Streaming ASR</a>
3433
<a href="#spk">Speaker Diarization</a>
3534
<a href="#emotion">Emotion Detection</a>
3635
<a href="#vad">VAD</a>
3736
<a href="#punc">Punctuation</a>
3837
<a href="#export">ONNX Export</a>
39-
<a href="#config">Configuration Reference</a>
40-
<a href="#faq">FAQ & Troubleshooting</a>
41-
</div>
38+
<div class="sb-title">Reference</div>
39+
<a href="#config">Configuration</a>
40+
<a href="#faq">FAQ</a>
41+
</nav>
42+
<div class="doc-content">
43+
<h1>Tutorial</h1>
44+
<p>From zero to production — learn FunASR in 10 minutes.</p>
45+
46+
4247

4348
<!-- 30-Second Demo -->
4449
<h2 id="quick">30-Second Demo</h2>
@@ -488,7 +493,8 @@ <h4>GPU not being used?</h4>
488493
# Specify GPU explicitly:
489494
model = AutoModel(model="...", device="cuda:0")</pre>
490495

491-
</div></div>
496+
</div><!-- doc-content -->
497+
</div><!-- doc-layout -->
492498

493499
<footer>
494500
<p>FunASR &middot; Tongyi Lab, Alibaba Group</p>

0 commit comments

Comments
 (0)