Skip to content

chore: Updated the documentation with a new look. #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+910 −98
Open

chore: Updated the documentation with a new look. #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 17 additions & 8 deletions docs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
site_name: LanceDB Documentation
site_name: LanceDB
site_url: https://lancedb.github.io/docs
repo_url: https://github.com/lancedb/lancedb
edit_uri: https://github.com/lancedb/documentation
Expand All @@ -13,20 +13,20 @@ theme:
logo: assets/logo.png
favicon: assets/logo.png
palette:
# Palette toggle for light mode
- scheme: default
primary: white
accent: black
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- scheme: slate
primary: black
accent: white
toggle:
icon: material/brightness-4
name: Switch to light mode
# Palette toggle for light mode
- scheme: default
primary: white
accent: black
toggle:
icon: material/brightness-7
name: Switch to dark mode

features:
- announce.dismiss
Expand Down Expand Up @@ -378,3 +378,12 @@ extra:
link: https://twitter.com/lancedb
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/lancedb
mainLanceDBURL: "http://lancedb-website-staging.s3-website-us-east-1.amazonaws.com"
cloudLanceDBURL: "https://cloud.lancedb.com"
privacyPdfURL: "https://lancedb.com/docs/LanceDB%20Privacy%20Policy.pdf"
termsPdfUrl: "https://lancedb.com/docs/LanceDB%20Cloud%20Terms%20of%20service.pdf"
discordURL: "https://discord.com/invite/G5DcmnZWKB"
supportURL: "mailto:[email protected]"
githubURL: "https://github.com/lancedb"
linkedInURL: "https://www.linkedin.com/company/lancedb/"
xURL: "https://x.com/lancedb"
5 changes: 3 additions & 2 deletions docs/overrides/main.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{% extends "base.html" %}

{% block announce %}
<div class="custom-announce" style="text-align: center;">June 1st, 2025: We just launched <a href="https://accounts.lancedb.com/sign-up" target="_blank" style="font-weight: bold;">LanceDB Cloud - Sign up and access LanceDB for free!</a></div>
{% endblock %}
{% include "partials/announcement.html" %}
{% endblock %}

194 changes: 194 additions & 0 deletions docs/overrides/partials/announcement.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,194 @@
<style>
html { font-size: 1rem; }
/*
html { font-size: calc(0.625rem + 0.41666666666666663vw); }
@media screen and (max-width:1920px) { html { font-size: calc(0.625rem + 0.41666666666666674vw); } }
@media screen and (max-width:1440px) { html { font-size: calc(0.8126951092611863rem + 0.20811654526534862vw); } }
@media screen and (max-width:479px) { html { font-size: calc(0.8747384937238494rem + 0.41841004184100417vw); } }
*/
</style>
<style>

/* Variables */
:root {
--dark-800: #171513;
--font--title-family: "Aeonik Fono", Arial, sans-serif;
--body-medium--font-size: 0px;
--body-medium--line-height: 1em;
--body-medium--letter-spacing: 0em;
--font--heading-family: "Aeonik Fono", Arial, sans-serif;
--swatch--heading-main-color: var(--pure-black);
--heading-large--font-size: 0px;
--heading-large--line-height: 1em;
--heading-large--letter-spacing: 0em;
--heading-medium--font-size: 0px;
--heading-medium--line-height: 1em;
--heading-medium--letter-spacing: 0em;
--heading-small--font-size: 0px;
--heading-small--line-height: 1em;
--heading-small--letter-spacing: 0em;
--title-large--font-size: 0px;
--title-large--line-height: 1em;
--title-large--letter-spacing: 0em;
--title-medium--font-size: 0px;
--title-medium--line-height: 1em;
--title-medium--letter-spacing: 0em;
--title-small--font-size: 0px;
--title-small--line-height: 1em;
--title-small--letter-spacing: 0em;
--swatch--body-main-color: var(--pure-black);
--horizontal-padding--desktop: 2.5rem;
--horizontal-padding--landscape: 1.25rem;
--dark-700: #1e1b19;
--container-max-width--main: 81rem;
--space--80px: 5rem;
--space--48px: 3rem;
--space--8px: .5rem;
--swatch--title-main-color: var(--pure-black);
--font--body-family: "Aeonik Pro", Arial, sans-serif;
--body-large--font-size: 0px;
--body-large--line-height: 1em;
--body-large--letter-spacing: 0em;
--body-small--font-size: 0px;
--body-small--line-height: 1em;
--body-small--letter-spacing: 0em;
--font--caption-family: "Aeonik Fono", Arial, sans-serif;
--swatch--caption-main-color: var(--pure-black);
--caption--font-size: 0px;
--caption--line-height: 1em;
--caption--letter-spacing: 0em;
--offwhite: #f4ebe8;
--space--24px: 1.5rem;
--space--40px: 2.5rem;
--space--64px: 4rem;
--space--28px: 1.75rem;
--space--4px: .25rem;
--orange-400: #ff734a;
--orange-500: #f56136;
--dark-500: #4c443f;
--dark-600: #302a25;
--dark-400: #847770;
--space--32px: 2rem;
--pure-white: white;
--space--16px: 1rem;
--lavende-400: #e7d2f6;
--dark-300: #998a84;
--dark-200: #ad9e95;
--dark-100: #e5dad4;
--pure-black: black;
--swatch--light-stroke: #ffffff26;
--swatch--dark-stroke: #00000026;
--max-width--none: 0px;
--heading-large--font-family: var(--font--heading-family);
--heading-large--font-weight: var(--font-weight--500);
--heading-large--text-transform: var(--text-transform--inherit);
--heading-large--color: var(--swatch--heading-main-color);
--heading-medium--font-family: var(--font--heading-family);
--heading-medium--font-weight: var(--font-weight--500);
--heading-medium--text-transform: var(--text-transform--inherit);
--heading-medium--color: var(--swatch--heading-main-color);
--heading-small--font-family: var(--font--heading-family);
--heading-small--font-weight: var(--font-weight--500);
--heading-small--text-transform: var(--text-transform--inherit);
--heading-small--color: var(--swatch--heading-main-color);
--title-large--font-family: var(--font--title-family);
--title-large--font-weight: var(--font-weight--500);
--title-large--text-transform: var(--text-transform--inherit);
--title-large--color: var(--swatch--title-main-color);
--title-medium--font-family: var(--font--title-family);
--title-medium--font-weight: var(--font-weight--500);
--title-medium--text-transform: var(--text-transform--inherit);
--title-medium--color: var(--swatch--title-main-color);
--title-small--font-family: var(--font--title-family);
--title-small--font-weight: var(--font-weight--500);
--title-small--text-transform: var(--text-transform--inherit);
--title-small--color: var(--swatch--title-main-color);
--body-large--font-family: var(--font--body-family);
--body-large--font-weight: var(--font-weight--500);
--body-large--text-transform: var(--text-transform--inherit);
--body-large--color: var(--swatch--body-main-color);
--body-large-emphasis--font-weight: var(--font-weight--700);
--body-medium--font-family: var(--font--body-family);
--body-medium--font-weight: var(--font-weight--500);
--body-medium--text-transform: var(--text-transform--inherit);
--body-medium--color: var(--swatch--body-main-color);
--body-medium-emphasis--font-weight: var(--font-weight--700);
--body-small--font-family: var(--font--body-family);
--body-small--font-weight: var(--font-weight--500);
--body-small--text-transform: var(--text-transform--inherit);
--body-small--color: var(--swatch--body-main-color);
--body-small-emphasis--font-weight: var(--font-weight--700);
--caption--font-family: var(--font--caption-family);
--caption--font-weight: var(--font-weight--500);
--caption--text-transform: var(--text-transform--inherit);
--caption--color: var(--swatch--caption-main-color);
--font-weight--100: 0px;
--font-weight--200: 0px;
--font-weight--300: 0px;
--font-weight--400: 0px;
--font-weight--500: 0px;
--font-weight--600: 0px;
--font-weight--700: 0px;
--font-weight--800: 0px;
--font-weight--900: 0px;
--font-weight--inherit: 0px;
--space--2px: .125rem;
--space--6px: .375rem;
--space--10px: .625rem;
--space--12px: .75rem;
--space--14px: .875rem;
--space--18px: 1.125rem;
--space--20px: 1.25rem;
--space--36px: 2.25rem;
--space--56px: 3.5rem;
--space--72px: 4.5rem;
--space--88px: 5.5rem;
--space--96px: 6rem;
--space--104px: 6.5rem;
--space--112px: 7rem;
--space--120px: 7.5rem;
--space--128px: 8rem;
--space--140px: 8.75rem;
--space--180px: 11.25rem;
--space--160px: 10rem;
--space--200px: 12.5rem;
--space--220px: 13.75rem;
--space--240px: 15rem;
}

.topbar_wrapper {
z-index: 15;
color: var(--dark-800);
background-image: linear-gradient(90deg, #e7d2f6, #ff734a);
justify-content: center;
align-items: center;
width: 100%;
font-size: .875rem;
line-height: 1.71429;
display: flex;
position: relative;
inset: 0% 0% auto;
overflow: hidden;
}

.topbar_link-wrapper {
grid-column-gap: .75rem;
grid-row-gap: .75rem;
justify-content: center;
align-items: center;
margin-left: auto;
margin-right: auto;
padding: .5rem 2rem;
display: flex;
}


.topbar_wrapper a {
color: var(--dark-800);
}

.topbar_wrapper a:hover {
color: var(--dark-800);
text-decoration:underline;
}
</style>
3 changes: 3 additions & 0 deletions docs/overrides/partials/discord.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M18.3859 6.16916C17.1889 5.6217 15.9177 5.2227 14.5908 5C14.4238 5.28766 14.2381 5.67738 14.1082 5.98359C12.6969 5.77944 11.2957 5.77944 9.90389 5.98359C9.77398 5.67738 9.57911 5.28766 9.42136 5C8.08519 5.2227 6.81395 5.6217 5.62529 6.16916C3.222 9.71378 2.57247 13.1748 2.89724 16.5896C4.49324 17.7495 6.03359 18.4547 7.54702 18.9187C7.91818 18.4176 8.25223 17.8793 8.53989 17.3134C7.99242 17.1092 7.47278 16.8587 6.97171 16.5618C7.10163 16.469 7.23154 16.367 7.35217 16.2648C10.3771 17.6475 13.6536 17.6475 16.6414 16.2648C16.7713 16.367 16.892 16.469 17.0219 16.5618C16.5208 16.8587 16.0012 17.1092 15.4538 17.3134C15.7414 17.8793 16.0754 18.4176 16.4466 18.9187C17.9591 18.4547 19.5087 17.7495 21.0964 16.5896C21.4953 12.6368 20.4645 9.20347 18.3859 6.16916ZM8.95744 14.4832C8.04808 14.4832 7.30575 13.6574 7.30575 12.646C7.30575 11.6346 8.02952 10.8087 8.95744 10.8087C9.87605 10.8087 10.6276 11.6346 10.6091 12.646C10.6091 13.6574 9.87605 14.4832 8.95744 14.4832ZM15.0548 14.4832C14.1454 14.4832 13.4021 13.6574 13.4021 12.646C13.4021 11.6346 14.1268 10.8087 15.0548 10.8087C15.9734 10.8087 16.725 11.6346 16.7064 12.646C16.7064 13.6574 15.9827 14.4832 15.0548 14.4832Z" fill="CurrentColor"></path>
</svg>
Loading