docs: Add stray design tweaks (#14205)

- Mostly just tweaking some design (colors & spacing) stuff
- Some small accessibility things—e.g., underline decoration for links
and one h1 only per page
- Most of the other captured changes are really just Prettier indenting
stuff

Release Notes:

- N/A
This commit is contained in:
Danilo Leal 2024-07-11 11:57:22 -03:00 committed by GitHub
parent 37fc4ce09d
commit c071e19899
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 526 additions and 540 deletions

File diff suppressed because it is too large Load diff

View file

@ -3,43 +3,43 @@
@import "variables.css"; @import "variables.css";
:root { :root {
/* Browser default font-size is 16px, this way 1 rem = 10px */ /* Browser default font-size is 16px, this way 1 rem = 10px */
font-size: 62.5%; font-size: 62.5%;
color-scheme: var(--color-scheme); color-scheme: var(--color-scheme);
} }
html { html {
font-family: var(--font); font-family: var(--font);
color: var(--fg); color: var(--fg);
background-color: var(--bg); background-color: var(--bg);
text-size-adjust: none; text-size-adjust: none;
-webkit-text-size-adjust: none; -webkit-text-size-adjust: none;
text-rendering: geometricPrecision !important; text-rendering: geometricPrecision !important;
-webkit-font-smoothing: antialiased !important; -webkit-font-smoothing: antialiased !important;
text-shadow: 1px 1px 1px rgba(0, 0, 0, 0.005); text-shadow: 1px 1px 1px rgba(0, 0, 0, 0.005);
} }
body { body {
margin: 0; margin: 0;
font-size: 1.6rem; font-size: 1.6rem;
overflow-x: hidden; overflow-x: hidden;
} }
code { code {
font-family: var(--mono-font) !important; font-family: var(--mono-font) !important;
font-size: var(--code-font-size); font-size: var(--code-font-size);
direction: ltr !important; direction: ltr !important;
} }
/* make long words/inline code not x overflow */ /* make long words/inline code not x overflow */
main { main {
overflow-wrap: break-word; overflow-wrap: break-word;
} }
/* make wide tables scroll if they overflow */ /* make wide tables scroll if they overflow */
.table-wrapper { .table-wrapper {
overflow-x: auto; overflow-x: auto;
} }
h1, h1,
@ -48,9 +48,9 @@ h3,
h4, h4,
h5, h5,
h6 { h6 {
font-family: var(--title-font); font-family: var(--title-font);
font-weight: normal; font-weight: normal;
color: var(--title-color); color: var(--title-color);
} }
/* Don't change font size in headers. */ /* Don't change font size in headers. */
@ -60,38 +60,39 @@ h3 code,
h4 code, h4 code,
h5 code, h5 code,
h6 code { h6 code {
font-size: unset; font-size: unset;
} }
.left { .left {
float: left; float: left;
} }
.right { .right {
float: right; float: right;
} }
.boring { .boring {
opacity: 0.6; opacity: 0.6;
} }
.hide-boring .boring { .hide-boring .boring {
display: none; display: none;
} }
.hidden { .hidden {
display: none !important; display: none !important;
} }
h2, h2,
h3 { h3 {
margin-block-start: 2.5em; margin-block-start: 2em;
margin-block-end: 0;
} }
h4, h4,
h5 { h5 {
margin-block-start: 2em; margin-block-start: 2em;
} }
.header + .header h3, .header + .header h3,
.header + .header h4, .header + .header h4,
.header + .header h5 { .header + .header h5 {
margin-block-start: 1em; margin-block-start: 1em;
} }
h1:target::before, h1:target::before,
@ -100,10 +101,10 @@ h3:target::before,
h4:target::before, h4:target::before,
h5:target::before, h5:target::before,
h6:target::before { h6:target::before {
display: inline-block; display: inline-block;
content: "»"; content: "»";
margin-inline-start: -30px; margin-inline-start: -30px;
width: 30px; width: 30px;
} }
/* This is broken on Safari as of version 14, but is fixed /* This is broken on Safari as of version 14, but is fixed
@ -111,187 +112,184 @@ h6:target::before {
https://bugs.webkit.org/show_bug.cgi?id=218076 https://bugs.webkit.org/show_bug.cgi?id=218076
*/ */
:target { :target {
/* Safari does not support logical properties */ /* Safari does not support logical properties */
scroll-margin-top: calc(var(--menu-bar-height) + 0.5em); scroll-margin-top: calc(var(--menu-bar-height) + 0.5em);
} }
.page { .page {
outline: 0; outline: 0;
padding: 0 var(--page-padding); padding: 0 var(--page-padding);
margin-block-start: calc( margin-block-start: calc(0px - var(--menu-bar-height)); /* Compensate for the #menu-bar-hover-placeholder */
0px - var(--menu-bar-height)
); /* Compensate for the #menu-bar-hover-placeholder */
} }
.page-wrapper { .page-wrapper {
box-sizing: border-box; box-sizing: border-box;
background-color: var(--bg); background-color: var(--bg);
} }
.no-js .page-wrapper, .no-js .page-wrapper,
.js:not(.sidebar-resizing) .page-wrapper { .js:not(.sidebar-resizing) .page-wrapper {
transition: transition:
margin-left 0.3s ease, margin-left 0.3s ease,
transform 0.3s ease; /* Animation: slide away */ transform 0.3s ease; /* Animation: slide away */
} }
[dir="rtl"] .js:not(.sidebar-resizing) .page-wrapper { [dir="rtl"] .js:not(.sidebar-resizing) .page-wrapper {
transition: transition:
margin-right 0.3s ease, margin-right 0.3s ease,
transform 0.3s ease; /* Animation: slide away */ transform 0.3s ease; /* Animation: slide away */
} }
.content { .content {
overflow-y: auto; overflow-y: auto;
padding: 0 5px 50px 5px; padding: 24px 4px 48px 4px;
} }
.content main { .content main {
margin-inline-start: auto; margin-inline-start: auto;
margin-inline-end: auto; margin-inline-end: auto;
max-width: var(--content-max-width); max-width: var(--content-max-width);
} }
.content p { .content p {
line-height: 1.625em; line-height: 1.625em;
} }
.content ol { .content ol {
line-height: 1.625em; line-height: 1.625em;
} }
.content ul { .content ul {
line-height: 1.625em; line-height: 1.625em;
} }
.content a { .content a {
text-decoration: none; text-decoration: underline;
text-decoration-color: hsl(219, 93%, 42%, 0.2);
} }
.content a:hover { .content a:hover {
text-decoration: underline; text-decoration-color: hsl(219, 93%, 42%, 0.5);
} }
.content img, .content img,
.content video { .content video {
max-width: 100%; max-width: 100%;
} }
.content .header:link, .content .header:link,
.content .header:visited { .content .header:visited {
color: var(--title-color); color: var(--title-color);
} }
.content .header:link, .content .header:link,
.content .header:visited:hover { .content .header:visited:hover {
text-decoration: none; text-decoration: none;
} }
table { table {
margin: 0 auto; margin: 0 auto;
border-collapse: collapse; border-collapse: collapse;
} }
table td { table td {
padding: 3px 20px; padding: 3px 20px;
border: 1px var(--table-border-color) solid; border: 1px var(--table-border-color) solid;
} }
table thead { table thead {
background: var(--table-header-bg); background: var(--table-header-bg);
} }
table thead td { table thead td {
font-weight: 700; font-weight: 700;
border: none; border: none;
} }
table thead th { table thead th {
padding: 3px 20px; padding: 3px 20px;
} }
table thead tr { table thead tr {
border: 1px var(--table-header-bg) solid; border: 1px var(--table-header-bg) solid;
} }
/* Alternate background colors for rows */ /* Alternate background colors for rows */
table tbody tr:nth-child(2n) { table tbody tr:nth-child(2n) {
background: var(--table-alternate-bg); background: var(--table-alternate-bg);
} }
blockquote { blockquote {
margin: 20px 0; margin: 20px 0;
padding: 0 20px; padding: 0 20px;
color: var(--fg); color: var(--fg);
background-color: var(--quote-bg); background-color: var(--quote-bg);
border-block-start: 0.1em solid var(--quote-border); border-block-start: 0.1em solid var(--quote-border);
border-block-end: 0.1em solid var(--quote-border); border-block-end: 0.1em solid var(--quote-border);
} }
.warning { .warning {
margin: 20px; margin: 20px;
padding: 0 20px; padding: 0 20px;
border-inline-start: 2px solid var(--warning-border); border-inline-start: 2px solid var(--warning-border);
} }
.warning:before { .warning:before {
position: absolute; position: absolute;
width: 3rem; width: 3rem;
height: 3rem; height: 3rem;
margin-inline-start: calc(-1.5rem - 21px); margin-inline-start: calc(-1.5rem - 21px);
content: "ⓘ"; content: "ⓘ";
text-align: center; text-align: center;
background-color: var(--bg); background-color: var(--bg);
color: var(--warning-border); color: var(--warning-border);
font-weight: bold; font-weight: bold;
font-size: 2rem; font-size: 2rem;
} }
blockquote .warning:before { blockquote .warning:before {
background-color: var(--quote-bg); background-color: var(--quote-bg);
} }
kbd { kbd {
background-color: rgba(8, 76, 207, 0.1); background-color: rgba(8, 76, 207, 0.1);
border-radius: 4px; border-radius: 4px;
border: solid 1px var(--theme-popup-border); border: solid 1px var(--theme-popup-border);
box-shadow: inset 0 -1px 0 var(--theme-hover); box-shadow: inset 0 -1px 0 var(--theme-hover);
display: inline-block; display: inline-block;
font-size: var(--code-font-size); font-size: var(--code-font-size);
font-family: var(--mono-font); font-family: var(--mono-font);
line-height: 10px; line-height: 10px;
padding: 4px 5px; padding: 4px 5px;
vertical-align: middle; vertical-align: middle;
} }
:not(.footnote-definition) + .footnote-definition, :not(.footnote-definition) + .footnote-definition,
.footnote-definition + :not(.footnote-definition) { .footnote-definition + :not(.footnote-definition) {
margin-block-start: 2em; margin-block-start: 2em;
} }
.footnote-definition { .footnote-definition {
font-size: 0.9em; font-size: 0.9em;
margin: 0.5em 0; margin: 0.5em 0;
} }
.footnote-definition p { .footnote-definition p {
display: inline; display: inline;
} }
.tooltiptext { .tooltiptext {
position: absolute; position: absolute;
visibility: hidden; visibility: hidden;
color: #fff; color: #fff;
background-color: #333; background-color: #333;
transform: translateX( transform: translateX(-50%); /* Center by moving tooltip 50% of its width left */
-50% left: -8px; /* Half of the width of the icon */
); /* Center by moving tooltip 50% of its width left */ top: -35px;
left: -8px; /* Half of the width of the icon */ font-size: 0.8em;
top: -35px; text-align: center;
font-size: 0.8em; border-radius: 6px;
text-align: center; padding: 5px 8px;
border-radius: 6px; margin: 5px;
padding: 5px 8px; z-index: 1000;
margin: 5px;
z-index: 1000;
} }
.tooltipped .tooltiptext { .tooltipped .tooltiptext {
visibility: visible; visibility: visible;
} }
.chapter li.part-title { .chapter li.part-title {
font-size: 20px; font-size: 18px;
font-family: var(--title-font); font-family: var(--title-font);
color: var(--title-color); color: var(--title-color);
margin: 5px 0px; margin: 5px 0;
margin-top: 3rem; margin-top: 2rem;
} }
.result-no-output { .result-no-output {
font-style: italic; font-style: italic;
} }
code.hljs { code.hljs {
color: rgb(75, 83, 97) !important; color: rgb(75, 83, 97) !important;
background-color: rgba(8, 76, 207, 0.1); background-color: rgba(8, 76, 207, 0.1);
} }

View file

@ -1,58 +1,56 @@
/* Globals */ /* Globals */
:root { :root {
--sidebar-width: 300px; --sidebar-width: 300px;
--sidebar-resize-indicator-width: 8px; --sidebar-resize-indicator-width: 0px;
--sidebar-resize-indicator-space: 2px; --sidebar-resize-indicator-space: 2px;
--page-padding: 15px; --page-padding: 15px;
--content-max-width: 750px; --content-max-width: 750px;
--menu-bar-height: 50px; --menu-bar-height: 50px;
--font: "IA Writer Quattro S", sans-serif; --font: "IA Writer Quattro S", sans-serif;
--title-font: "Agrandir", "Helvetica Neue", Helvetica, Arial, sans-serif; --title-font: "Agrandir", "Helvetica Neue", Helvetica, Arial, sans-serif;
--mono-font: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, --mono-font: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, Liberation Mono, Courier New, monospace;
Liberation Mono, Courier New, monospace; --code-font-size: 0.875em /* please adjust the ace font size accordingly in editor.js */;
--code-font-size: 0.875em
/* please adjust the ace font size accordingly in editor.js */;
--bg: rgb(246, 245, 240); --bg: rgb(246, 245, 240);
--fg: rgb(75, 83, 97); --fg: rgb(75, 83, 97);
--title-color: rgb(8, 76, 207); --title-color: rgb(8, 76, 207);
--sidebar-fg: hsl(0, 0%, 0%); --sidebar-fg: hsl(0, 0%, 0%);
--sidebar-non-existant: #aaaaaa; --sidebar-non-existant: #aaaaaa;
--sidebar-active: rgb(8, 76, 207); --sidebar-active: rgb(8, 76, 207);
--sidebar-spacer: #f4f4f4; --sidebar-spacer: #f4f4f4;
--scrollbar: #8f8f8f; --scrollbar: #8f8f8f;
--icons: #747474; --icons: #747474;
--icons-hover: #000000; --icons-hover: #000000;
--links: rgb(8, 76, 207); --links: rgb(8, 76, 207);
--inline-code-color: #301900; --inline-code-color: #301900;
--theme-popup-bg: #fafafa; --theme-popup-bg: #fafafa;
--theme-popup-border: #cccccc; --theme-popup-border: #cccccc;
--theme-hover: #e6e6e6; --theme-hover: #e6e6e6;
--quote-bg: hsl(197, 37%, 96%); --quote-bg: hsl(197, 37%, 96%);
--quote-border: hsl(197, 37%, 91%); --quote-border: hsl(197, 37%, 91%);
--warning-border: #ff8e00; --warning-border: #ff8e00;
--table-border-color: hsl(0, 0%, 95%); --table-border-color: hsl(219, 93%, 42%, 0.15);
--table-header-bg: hsl(0, 0%, 80%); --table-header-bg: hsl(0, 0%, 80%);
--table-alternate-bg: hsl(0, 0%, 97%); --table-alternate-bg: hsl(0, 0%, 97%);
--searchbar-border-color: #aaa; --searchbar-border-color: #aaa;
--searchbar-bg: #fafafa; --searchbar-bg: #fafafa;
--searchbar-fg: #000; --searchbar-fg: #000;
--searchbar-shadow-color: #aaa; --searchbar-shadow-color: #aaa;
--searchresults-header-fg: #666; --searchresults-header-fg: #666;
--searchresults-border-color: #888; --searchresults-border-color: #888;
--searchresults-li-bg: #e4f2fe; --searchresults-li-bg: #e4f2fe;
--search-mark-bg: #a2cff5; --search-mark-bg: #a2cff5;
--color-scheme: light; --color-scheme: light;
} }

View file

@ -124,7 +124,7 @@
{{> header}} {{> header}}
<div id="menu-bar-hover-placeholder"></div> <div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky"> <div id="menu-bar" class="menu-bar sticky">
<div class="left-buttons" style="height: 36px; margin-top: 16px"> <div class="left-buttons">
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar"> <label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i> <i class="fa fa-bars"></i>
</label> </label>
@ -145,11 +145,11 @@
{{/if}} {{/if}}
</div> </div>
<h1 class="menu-title"> <header class="menu-title">
<a href="/"> <a href="/">
<img src="https://zed.dev/logo_wordmark_36.webp" alt="Zed Industries" style="margin-top: 24px; height: 36px;"> <img src="https://zed.dev/logo_wordmark_36.webp" alt="Zed Industries" style="height: 28px;">
</a> </a>
</h1> </header>
<div class="right-buttons"> <div class="right-buttons">
<a class="download-button" href="https://zed.dev/download" title="Download Zed" aria-label="Download Zed"> <a class="download-button" href="https://zed.dev/download" title="Download Zed" aria-label="Download Zed">