diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 35c297e0..c82ef510 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -11,7 +11,7 @@ watch: theme: name: "material" logo: assets/logo.png - favicon: assets/logo.png + favicon: assets/favicon.ico palette: # Palette toggle for light mode - scheme: lancedb @@ -32,8 +32,6 @@ theme: - content.tooltips - toc.follow - navigation.top - - navigation.tabs - - navigation.tabs.sticky - navigation.footer - navigation.tracking - navigation.instant @@ -115,12 +113,13 @@ markdown_extensions: emoji_index: !!python/name:material.extensions.emoji.twemoji emoji_generator: !!python/name:material.extensions.emoji.to_svg - markdown.extensions.toc: - baselevel: 1 - permalink: "" + toc_depth: 3 + permalink: true + permalink_title: Anchor link to this section nav: - - API reference: - - Overview: index.md + - Documentation: + - SDK Reference: index.md - Python: python/python.md - Javascript/TypeScript: js/globals.md - Java: java/java.md diff --git a/docs/src/assets/favicon.ico b/docs/src/assets/favicon.ico new file mode 100644 index 00000000..911581be Binary files /dev/null and b/docs/src/assets/favicon.ico differ diff --git a/docs/src/index.md b/docs/src/index.md index c2dbabe0..b8ad3af3 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,8 +1,12 @@ -# API Reference +# SDK Reference -This page contains the API reference for the SDKs supported by the LanceDB team. +This site contains the API reference for the client SDKs supported by [LanceDB](https://lancedb.com). - [Python](python/python.md) - [JavaScript/TypeScript](js/globals.md) - [Java](java/java.md) -- [Rust](https://docs.rs/lancedb/latest/lancedb/index.html) \ No newline at end of file +- [Rust](https://docs.rs/lancedb/latest/lancedb/index.html) + +!!! info "LanceDB Documentation" + + If you're looking for the full documentation of LanceDB, visit [docs.lancedb.com](https://docs.lancedb.com). diff --git a/docs/src/styles/extra.css b/docs/src/styles/extra.css index ec5a6d81..9ceccd80 100644 --- a/docs/src/styles/extra.css +++ b/docs/src/styles/extra.css @@ -85,17 +85,26 @@ /* Header gradient (only header area) */ .md-header { - background: linear-gradient(90deg, #3B2E58 0%, #F0B7C1 45%, #E55A2B 100%); + background: linear-gradient(90deg, #e4d8f8 0%, #F0B7C1 45%, #E55A2B 100%); box-shadow: inset 0 1px 0 rgba(255,255,255,0.08), 0 1px 0 rgba(0,0,0,0.08); } +/* Improve brand title contrast on the lavender side */ +.md-header__title, +.md-header__topic, +.md-header__title .md-ellipsis, +.md-header__topic .md-ellipsis { + color: #2b1b3a; + text-shadow: 0 1px 0 rgba(255, 255, 255, 0.25); +} + /* Same colors as header for tabs (that hold the text) */ .md-tabs { - background: linear-gradient(90deg, #3B2E58 0%, #F0B7C1 45%, #E55A2B 100%); + background: linear-gradient(90deg, #e4d8f8 0%, #F0B7C1 45%, #E55A2B 100%); } /* Dark scheme variant */ [data-md-color-scheme="slate"] .md-header, [data-md-color-scheme="slate"] .md-tabs { - background: linear-gradient(90deg, #3B2E58 0%, #F0B7C1 45%, #E55A2B 100%); + background: linear-gradient(90deg, #e4d8f8 0%, #F0B7C1 45%, #E55A2B 100%); }