Skip to content

Commit b21fc86

Browse files
Improve docs layout (#2132)
Signed-off-by: Travis Beckham <travis@buoyant.io>
1 parent ac89d74 commit b21fc86

5 files changed

Lines changed: 52 additions & 34 deletions

File tree

linkerd.io/assets/scss/pages/_docs.scss

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@
1515
display: grid;
1616
grid-template-columns: 1fr;
1717
}
18+
.docs__gap-start,
19+
.docs__gap-end {
20+
// Hide until xxl breakpoint
21+
display: none;
22+
}
1823
.docs__sidebar {
1924
background-color: abstracts.$light-gray;
2025
}
@@ -102,9 +107,7 @@
102107
}
103108
}
104109
.docs__body {
105-
max-width: 800px;
106-
padding-left: abstracts.size(4);
107-
padding-right: abstracts.size(4);
110+
padding: 0 abstracts.size(4);
108111
}
109112
@media (min-width: abstracts.breakpoint-min-width("md")) {
110113
.docs__sidebar {
@@ -118,7 +121,7 @@
118121
justify-content: flex-end;
119122
}
120123
.docs__nav {
121-
width: 300px;
124+
width: 100%;
122125
padding: 0 0 0 abstracts.size(4);
123126
}
124127
.docs__versions,
@@ -128,14 +131,31 @@
128131
}
129132
@media (min-width: abstracts.breakpoint-min-width("xl")) {
130133
.docs__body {
131-
padding-left: abstracts.size(7);
134+
padding: 0 abstracts.size(6);
132135
}
133136
}
134137
@media (min-width: abstracts.breakpoint-min-width("xxl")) {
135138
.docs__container {
136-
grid-template-columns: 33% 1fr;
139+
grid-template-columns: 1fr 360px 960px 1fr;
140+
grid-template-areas: "docsGapStart docsSidebar docsMain docsGapEnd"
137141
}
138-
.docs__nav {
139-
width: 350px;
142+
.docs__gap-start {
143+
display: block;
144+
grid-row: docsGapStart;
145+
background-color: abstracts.$light-gray;
146+
}
147+
.docs__gap-end {
148+
display: block;
149+
grid-row: docsGapEnd;
150+
}
151+
.docs__sidebar {
152+
grid-row: docsSidebar;
153+
}
154+
.docs__main {
155+
grid-row: docsMain;
156+
}
157+
.docs__body {
158+
padding-left: abstracts.size(7);
159+
padding-right: 0;
140160
}
141161
}

linkerd.io/layouts/docs/_docs.html

Lines changed: 0 additions & 20 deletions
This file was deleted.

linkerd.io/layouts/docs/all.html

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{{ define "main" }}
2+
{{ .Render "_docs-deprecated-alert" }}
3+
<div class="docs">
4+
<div class="docs__container">
5+
<div class="docs__gap-start"></div>
6+
<div class="docs__sidebar">
7+
{{ .Render "_docs-nav" }}
8+
</div>
9+
<div class="docs__main">
10+
<div class="docs__body">
11+
<div class="docs__header">
12+
<h1>
13+
{{ .Title }}
14+
</h1>
15+
</div>
16+
<div class="docs__content prose">
17+
{{ .Content }}
18+
</div>
19+
</div>
20+
</div>
21+
<div class="docs__gap-end"></div>
22+
</div>
23+
</div>
24+
{{ end }}

linkerd.io/layouts/docs/list.html

Lines changed: 0 additions & 3 deletions
This file was deleted.

linkerd.io/layouts/docs/single.html

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)