Skip to content

Commit 636954f

Browse files
authored
feat: add initial documentation for SQLSpec (#100)
Introduce foundational documentation including getting started guides, contributing instructions, and an overview of SQLSpec's features and usage. This enhances the project's accessibility for new users and contributors.
1 parent 0c401fd commit 636954f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+7381
-3891
lines changed

docs/Makefile

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

docs/_static/custom.css

Lines changed: 56 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
--brand-font-size-lg: 5rem;
55
--brand-font-size-md: 4rem;
66
--brand-font-size-sm: 2.5rem;
7-
--brand-font-size-xs: 1.8rem;
8-
--brand-font-size-xxs: 1.6rem;
7+
--brand-font-size-xs: 2rem; /* Increased from 1.8rem */
8+
--brand-font-size-xxs: 1.9rem; /* Increased from 1.6rem */
99

1010
--brand-letter-spacing-xl: 0.25em;
1111
--brand-letter-spacing-lg: 0.2em;
1212
--brand-letter-spacing-md: 0.1em;
1313
--brand-letter-spacing-sm: 0.05em;
14-
--brand-letter-spacing-xs: 0.03em;
14+
--brand-letter-spacing-xs: 0.04em; /* Increased from 0.03em */
1515
}
1616

1717
html.light {
@@ -56,12 +56,8 @@ html[class] .title-with-logo .brand-text {
5656
text-align: center;
5757
line-height: 1.4;
5858
max-width: 100%;
59-
word-break: break-word;
60-
word-wrap: break-word;
61-
overflow-wrap: break-word;
62-
hyphens: auto;
63-
-webkit-hyphens: auto;
64-
-ms-hyphens: auto;
59+
white-space: nowrap;
60+
overflow: visible;
6561
transition: color var(--sl-transition), text-shadow var(--sl-transition);
6662
}
6763

@@ -86,13 +82,29 @@ html.dark .title-with-logo .brand-text {
8682
flex: 0 0 auto;
8783
}
8884

89-
/* Large screens */
90-
@media (min-width: 1200px) {
85+
/* Extra large screens */
86+
@media (min-width: 1400px) {
9187
html[class] .title-with-logo .brand-text {
9288
font-size: var(--brand-font-size-xl);
9389
}
9490
}
9591

92+
/* Large screens */
93+
@media (min-width: 1200px) and (max-width: 1399px) {
94+
html[class] .title-with-logo .brand-text {
95+
font-size: var(--brand-font-size-lg);
96+
letter-spacing: var(--brand-letter-spacing-lg);
97+
}
98+
}
99+
100+
/* Medium screens - prevent wrapping with sidebar */
101+
@media (min-width: 992px) and (max-width: 1199px) {
102+
html[class] .title-with-logo .brand-text {
103+
font-size: var(--brand-font-size-md);
104+
letter-spacing: var(--brand-letter-spacing-md);
105+
}
106+
}
107+
96108
/* Medium-small screens */
97109
@media (max-width: 991px) {
98110
html[class] .title-with-logo .brand-text {
@@ -133,6 +145,39 @@ html.dark .title-with-logo .brand-text {
133145
}
134146
}
135147

148+
/* Hide logo text in header to reduce redundancy */
149+
.sy-head-brand strong {
150+
display: none;
151+
}
152+
153+
/* Ensure brand text is semantically correct h1 */
154+
html[class] .title-with-logo h1.brand-text {
155+
margin: 0;
156+
padding: 0;
157+
border: none;
158+
}
159+
160+
/* Adjust spacing after brand text for better flow */
161+
.title-with-logo + p {
162+
margin-top: 2rem;
163+
}
164+
165+
/* Subtle fade-in animation for brand text */
166+
@keyframes fadeInScale {
167+
from {
168+
opacity: 0;
169+
transform: scale(0.95);
170+
}
171+
to {
172+
opacity: 1;
173+
transform: scale(1);
174+
}
175+
}
176+
177+
.title-with-logo .brand-text {
178+
animation: fadeInScale 0.6s ease-out;
179+
}
180+
136181
/* Preserve existing layout styles */
137182
#badges img {
138183
margin-top: 0;

docs/cheat_sheet/README.md

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

0 commit comments

Comments
 (0)