diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index a539930..7977fa8 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -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 @@ -13,13 +13,6 @@ 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 @@ -27,6 +20,13 @@ theme: 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 @@ -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:support@lancedb.com" + githubURL: "https://github.com/lancedb" + linkedInURL: "https://www.linkedin.com/company/lancedb/" + xURL: "https://x.com/lancedb" diff --git a/docs/overrides/main.html b/docs/overrides/main.html index 17a50df..01276a0 100644 --- a/docs/overrides/main.html +++ b/docs/overrides/main.html @@ -1,5 +1,6 @@ {% extends "base.html" %} {% block announce %} -
June 1st, 2025: We just launched LanceDB Cloud - Sign up and access LanceDB for free!
-{% endblock %} \ No newline at end of file +{% include "partials/announcement.html" %} +{% endblock %} + diff --git a/docs/overrides/partials/announcement.html b/docs/overrides/partials/announcement.html new file mode 100644 index 0000000..602c1cd --- /dev/null +++ b/docs/overrides/partials/announcement.html @@ -0,0 +1,194 @@ + + diff --git a/docs/overrides/partials/discord.html b/docs/overrides/partials/discord.html new file mode 100644 index 0000000..d976bc5 --- /dev/null +++ b/docs/overrides/partials/discord.html @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/overrides/partials/footer.html b/docs/overrides/partials/footer.html new file mode 100644 index 0000000..29e9bd3 --- /dev/null +++ b/docs/overrides/partials/footer.html @@ -0,0 +1,228 @@ + + +
+
+
+
+
+
+
LanceDB
+ +
+
+
RESOURCES
+ +
+
+
LEGAL
+ +
+
+
FOLLOW US
+ +
+
+
+
+
+
+
+
Certifications
+ +
+
© 2025 LanceDB Inc. All rights reserved.
+
+
+ diff --git a/docs/overrides/partials/github.html b/docs/overrides/partials/github.html new file mode 100644 index 0000000..94b429a --- /dev/null +++ b/docs/overrides/partials/github.html @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/overrides/partials/header.html b/docs/overrides/partials/header.html new file mode 100644 index 0000000..a240a38 --- /dev/null +++ b/docs/overrides/partials/header.html @@ -0,0 +1,287 @@ + + +
+ + + +
+ {% include "partials/logo.html" %} +
+ + +
diff --git a/docs/overrides/partials/linkedin.html b/docs/overrides/partials/linkedin.html new file mode 100644 index 0000000..12406e7 --- /dev/null +++ b/docs/overrides/partials/linkedin.html @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/docs/overrides/partials/logo.html b/docs/overrides/partials/logo.html new file mode 100644 index 0000000..2756950 --- /dev/null +++ b/docs/overrides/partials/logo.html @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/overrides/partials/x.html b/docs/overrides/partials/x.html new file mode 100644 index 0000000..c856044 --- /dev/null +++ b/docs/overrides/partials/x.html @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/src/assets/lancedb_logo.svg b/docs/src/assets/lancedb_logo.svg new file mode 100644 index 0000000..0d0bed4 --- /dev/null +++ b/docs/src/assets/lancedb_logo.svg @@ -0,0 +1,14 @@ + + + diff --git a/docs/src/fonts/AeonikFono-Medium.woff2 b/docs/src/fonts/AeonikFono-Medium.woff2 new file mode 100644 index 0000000..549e55e Binary files /dev/null and b/docs/src/fonts/AeonikFono-Medium.woff2 differ diff --git a/docs/src/fonts/AeonikFono-Regular.woff2 b/docs/src/fonts/AeonikFono-Regular.woff2 new file mode 100644 index 0000000..b8543f4 Binary files /dev/null and b/docs/src/fonts/AeonikFono-Regular.woff2 differ diff --git a/docs/src/fonts/AeonikPro-Medium.woff2 b/docs/src/fonts/AeonikPro-Medium.woff2 new file mode 100644 index 0000000..16ece62 Binary files /dev/null and b/docs/src/fonts/AeonikPro-Medium.woff2 differ diff --git a/docs/src/fonts/AeonikPro-Regular.woff2 b/docs/src/fonts/AeonikPro-Regular.woff2 new file mode 100644 index 0000000..c9cf4b0 Binary files /dev/null and b/docs/src/fonts/AeonikPro-Regular.woff2 differ diff --git a/docs/src/styles/links.css b/docs/src/styles/links.css index 9953e69..c5d29de 100644 --- a/docs/src/styles/links.css +++ b/docs/src/styles/links.css @@ -1,3 +1,27 @@ +/* Google Fonts Import */ +/* Custom Font Declarations - Aeonik */ +@font-face { + font-family: 'Aeonik'; + src: url('../fonts/aeonik-regular.woff2') format('woff2'), + url('../fonts/aeonik-regular.woff') format('woff'); + font-weight: 400; + font-style: normal; + font-display: swap; +} + +@font-face { + font-family: 'Aeonik'; + src: url('../fonts/aeonik-medium.woff2') format('woff2'), + url('../fonts/aeonik-medium.woff') format('woff'); + font-weight: 500; + font-style: normal; + font-display: swap; +} + +body { + font-family: 'Aeonik', Arial, sans-serif; +} + /* ========================================================================== Theme Variables ========================================================================== */ @@ -5,47 +29,47 @@ /* Light mode (default) theme variables */ [data-md-color-scheme="default"] { /* Link colors */ - --md-typeset-a-color: #000000; - --md-typeset-a-color--hover: #000000; - --md-primary-fg-color: #000000; - --md-accent-fg-color: #000000; + --md-typeset-a-color: var(--dark-800); + --md-typeset-a-color--hover: var(--dark-800); + --md-primary-fg-color: var(--dark-800); + --md-accent-fg-color: var(--dark-800); --md-accent-fg-color--transparent: rgba(0, 0, 0, 0.1); - --md-default-fg-color: #000000; + --md-default-fg-color: var(--dark-800); /* Header + Footer colors */ - --md-footer-fg-color: #000000; - --md-footer-fg-color--light: #000000; - --md-footer-fg-color--lighter: #000000; + --md-footer-fg-color: var(--dark-800); + --md-footer-fg-color--light: var(--dark-800); + --md-footer-fg-color--lighter: var(--dark-800); /* Announcement Strip colors */ --md-footer-bg-color: #ececec; /* Footer colors */ - --md-footer-bg-color--dark: #ffffff; + --md-footer-bg-color--dark: var(--offwhite); } /* Dark mode (slate) theme variables */ [data-md-color-scheme="slate"] { /* Link colors */ - --md-typeset-a-color: #ffffff; - --md-typeset-a-color--hover: #ffffff; - --md-primary-fg-color: #ffffff; - --md-accent-fg-color: #ffffff; + --md-typeset-a-color: var(--offwhite); + --md-typeset-a-color--hover: var(--offwhite); + --md-primary-fg-color: var(--offwhite); + --md-accent-fg-color: var(--offwhite); --md-accent-fg-color--transparent: rgba(255, 255, 255, 0.1); - --md-default-fg-color: #ffffff; + --md-default-fg-color: var(--offwhite); /* Footer colors */ - --md-footer-fg-color: #ffffff; - --md-footer-fg-color--light: #ffffff; - --md-footer-fg-color--lighter: #ffffff; - --md-footer-bg-color: #000000; - --md-footer-bg-color--dark: #000000; + --md-footer-fg-color: var(--offwhite); + --md-footer-fg-color--light: var(--offwhite); + --md-footer-fg-color--lighter: var(--offwhite); + --md-footer-bg-color: var(--dark-800); + --md-footer-bg-color--dark: var(--dark-800); /* Background colors */ - --md-primary-bg-color: #000000; - --md-primary-bg-color--light: #000000; - --md-default-bg-color: #000000; - --md-default-bg-color--light: #000000; - --md-default-bg-color--lighter: #000000; - --md-default-bg-color--lightest: #000000; + --md-primary-bg-color: var(--dark-800); + --md-primary-bg-color--light: var(--dark-800); + --md-default-bg-color: var(--dark-800); + --md-default-bg-color--light: var(--dark-800); + --md-default-bg-color--lighter: var(--dark-800); + --md-default-bg-color--lightest: var(--dark-800); } /* ========================================================================== @@ -54,36 +78,35 @@ /* Light mode header */ [data-md-color-scheme="default"] .md-header { - background-color: #ffffff; + background-color: var(--offwhite); } -[data-md-color-scheme="default"] .md-header__button, [data-md-color-scheme="default"] .md-header__source, [data-md-color-scheme="default"] .md-tabs__link, [data-md-color-scheme="default"] .md-header__title, [data-md-color-scheme="default"] .md-header__source { - color: #000000 !important; + color: var(--dark-800) !important; font-weight: bold !important; } [data-md-color-scheme="default"] .md-header__button:hover, [data-md-color-scheme="default"] .md-tabs__link:hover { - color: #000000 !important; + color: var(--dark-800) !important; opacity: 0.8; } [data-md-color-scheme="default"] .md-tabs__link--active { - color: #000000 !important; + color: var(--dark-800) !important; font-weight: bold !important; } [data-md-color-scheme="default"] .md-tabs { - background-color: #ffffff; + background-color: var(--offwhite); } /* Dark mode header */ [data-md-color-scheme="slate"] .md-header { - background-color: #000000; + background-color: var(--dark-800); } [data-md-color-scheme="slate"] .md-header__button, @@ -91,23 +114,34 @@ [data-md-color-scheme="slate"] .md-tabs__link, [data-md-color-scheme="slate"] .md-header__title, [data-md-color-scheme="slate"] .md-header__source { - color: #ffffff !important; + color: var(--offwhite) !important; font-weight: bold !important; } -[data-md-color-scheme="slate"] .md-header__button:hover, +[data-md-color-scheme="slate"] .md-header__button { + position: absolute; + top: 0; + left: 0; + z-index: 1000; +} + + +[data-md-color-scheme="slate"] .md-header__button:hover { + opacity: 0.8; +} + [data-md-color-scheme="slate"] .md-tabs__link:hover { - color: #ffffff !important; + color: var(--offwhite) !important; opacity: 0.8; } [data-md-color-scheme="slate"] .md-tabs__link--active { - color: #ffffff !important; + color: var(--offwhite) !important; font-weight: bold !important; } [data-md-color-scheme="slate"] .md-tabs { - background-color: #000000; + background-color: var(--dark-800); } /* ========================================================================== @@ -116,7 +150,7 @@ /* Light mode sidebar */ [data-md-color-scheme="default"] .md-nav__item .md-nav__link { - color: #000000 !important; + color: var(--dark-800) !important; } [data-md-color-scheme="default"] .md-nav__item .md-nav__link:hover { @@ -125,29 +159,29 @@ } [data-md-color-scheme="default"] .md-nav__item .md-nav__link--active { - color: #000000 !important; + color: var(--dark-800) !important; } [data-md-color-scheme="default"] .md-nav__link[for] { - color: #000000 !important; + color: var(--dark-800) !important; } [data-md-color-scheme="default"] .md-nav__link[for]:hover { - color: #000000 !important; + color: var(--dark-800) !important; opacity: 0.8; } [data-md-color-scheme="default"] .md-nav__link[for].md-nav__link--active { - color: #000000 !important; + color: var(--dark-800) !important; } [data-md-color-scheme="default"] .md-nav__title { - color: #000000 !important; + color: var(--dark-800) !important; } /* Dark mode sidebar */ [data-md-color-scheme="slate"] .md-nav__item .md-nav__link { - color: #ffffff !important; + color: var(--offwhite) !important; } [data-md-color-scheme="slate"] .md-nav__item .md-nav__link:hover { @@ -156,24 +190,24 @@ } [data-md-color-scheme="slate"] .md-nav__item .md-nav__link--active { - color: #ffffff !important; + color: var(--offwhite) !important; } [data-md-color-scheme="slate"] .md-nav__link[for] { - color: #ffffff !important; + color: var(--offwhite) !important; } [data-md-color-scheme="slate"] .md-nav__link[for]:hover { - color: #ffffff !important; + color: var(--offwhite) !important; opacity: 0.8; } [data-md-color-scheme="slate"] .md-nav__link[for].md-nav__link--active { - color: #ffffff !important; + color: var(--offwhite) !important; } [data-md-color-scheme="slate"] .md-nav__title { - color: #ffffff !important; + color: var(--offwhite) !important; } /* Active sidebar link styles */ @@ -203,46 +237,46 @@ /* Light mode footer */ [data-md-color-scheme="default"] .md-footer { - background-color: #000000; + background-color: var(--dark-800); } [data-md-color-scheme="default"] .md-footer__link { - color: #ffffff !important; + color: var(--offwhite) !important; } [data-md-color-scheme="default"] .md-footer__link:hover { - color: #ffffff !important; + color: var(--offwhite) !important; opacity: 0.8; } [data-md-color-scheme="default"] .md-footer__title { - color: #ffffff !important; + color: var(--offwhite) !important; } [data-md-color-scheme="default"] .md-footer__copyright { - color: #ffffff !important; + color: var(--offwhite) !important; } /* Dark mode footer */ [data-md-color-scheme="slate"] .md-footer { - background-color: #000000; + background-color: var(--dark-800); } [data-md-color-scheme="slate"] .md-footer__link { - color: #ffffff !important; + color: var(--offwhite) !important; } [data-md-color-scheme="slate"] .md-footer__link:hover { - color: #ffffff !important; + color: var(--offwhite) !important; opacity: 0.8; } [data-md-color-scheme="slate"] .md-footer__title { - color: #ffffff !important; + color: var(--offwhite) !important; } [data-md-color-scheme="slate"] .md-footer__copyright { - color: #ffffff !important; + color: var(--offwhite) !important; } /* ========================================================================== @@ -277,7 +311,7 @@ /* Code block styles */ [data-md-color-scheme="slate"] .md-typeset code { - color: #ffffff; + color: var(--offwhite); background-color: #1a1a1a; } @@ -287,55 +321,55 @@ /* Light mode buttons */ [data-md-color-scheme="default"] .md-button { - color: #000000 !important; - background-color: #ffffff !important; - border-color: #000000 !important; + color: var(--dark-800) !important; + background-color: var(--offwhite) !important; + border-color: var(--dark-800) !important; } [data-md-color-scheme="default"] .md-button:hover { - color: #000000 !important; + color: var(--dark-800) !important; background-color: #f0f0f0 !important; - border-color: #000000 !important; + border-color: var(--dark-800) !important; opacity: 0.8; } [data-md-color-scheme="default"] .md-button--primary { - color: #000000 !important; - background-color: #ffffff !important; - border-color: #000000 !important; + color: var(--dark-800) !important; + background-color: var(--offwhite) !important; + border-color: var(--dark-800) !important; } [data-md-color-scheme="default"] .md-button--primary:hover { - color: #000000 !important; + color: var(--dark-800) !important; background-color: #f0f0f0 !important; - border-color: #000000 !important; + border-color: var(--dark-800) !important; opacity: 0.8; } /* Dark mode buttons */ [data-md-color-scheme="slate"] .md-button { - color: #ffffff !important; + color: var(--offwhite) !important; background-color: #1a1a1a !important; - border-color: #ffffff !important; + border-color: var(--offwhite) !important; } [data-md-color-scheme="slate"] .md-button:hover { - color: #ffffff !important; + color: var(--offwhite) !important; background-color: #333333 !important; - border-color: #ffffff !important; + border-color: var(--offwhite) !important; opacity: 0.8; } [data-md-color-scheme="slate"] .md-button--primary { - color: #ffffff !important; + color: var(--offwhite) !important; background-color: #1a1a1a !important; - border-color: #ffffff !important; + border-color: var(--offwhite) !important; } [data-md-color-scheme="slate"] .md-button--primary:hover { - color: #ffffff !important; + color: var(--offwhite) !important; background-color: #333333 !important; - border-color: #ffffff !important; + border-color: var(--offwhite) !important; opacity: 0.8; } @@ -348,40 +382,57 @@ } [data-md-color-scheme="slate"] .md-nav__source { - background-color: #000000; + background-color: var(--dark-800); } [data-md-color-scheme="slate"] .md-search__input { background-color: #1a1a1a; - color: #ffffff; + color: var(--offwhite); } [data-md-color-scheme="slate"] .md-search__input::placeholder { - color: #ffffff; + color: var(--offwhite); } [data-md-color-scheme="slate"] .md-search__input + .md-search__icon { - color: #ffffff; + color: var(--offwhite); } [data-md-color-scheme="slate"] .md-search__scrollwrap { - background-color: #000000; + background-color: var(--dark-800); } [data-md-color-scheme="slate"] .md-search__scrollwrap::-webkit-scrollbar-thumb { - background-color: #ffffff; + background-color: var(--offwhite); } [data-md-color-scheme="slate"] .md-search__scrollwrap::-webkit-scrollbar-track { - background-color: #000000; + background-color: var(--dark-800); } /* Content link overrides */ [data-md-color-scheme="slate"] .md-content__inner a { - color: #ffffff !important; + color: var(--offwhite) !important; } [data-md-color-scheme="slate"] .md-content__inner a:hover { - color: #ffffff !important; + color: var(--offwhite) !important; opacity: 0.8; -} \ No newline at end of file +} + +[data-md-color-scheme="slate"] .md-banner__inner { + margin: 0; + padding: 0; + max-width: 100% !important; +} + +[data-md-color-scheme="slate"] .md-banner__button { + display: none; +} +[data-md-color-scheme="slate"] .md-grid { + max-width: 100%; +} + +[data-md-color-scheme="slate"] .md-nav { + background-color: var(--md-primary-bg-color); +}