Chapter: README (docs/README.md) Copy Section

Lance Documentation

This directory contains the documentation for Lance, built with MkDocs and a
custom theme (theme/) implementing the Lance Docs design.

Getting Started with uv Copy Chapter

Setup Copy Section

1. Install uv if you haven't already:

curl -LsSf https://astral.sh/uv/install.sh | sh

2. That's it! No manual dependency installation needed.

Building Documentation Copy Section

To build and serve the documentation locally:

make serve

The documentation will be available at http://localhost:8000

Building for Production Copy Section

make build

This will create a site/ directory with the built documentation.

Managing Dependencies Copy Section

#### Adding Dependencies

Add a dependency and update pyproject.toml

uv add <package>
Add a dev dependency

uv add --dev <package>

#### Manual Sync (if needed)

make sync

#### Upgrading Dependencies

Upgrade a specific package

uv add <package>@latest
Upgrade all dependencies

uv sync --upgrade

Project Structure Copy Chapter

- src/ - Source markdown files for documentation
- theme/ - Custom MkDocs theme implementing the Lance Docs design
(templates in *.html, styles/behaviour in theme/assets/)
- mkdocs.yml - MkDocs configuration
- pyproject.toml - Python project configuration (uv compatible)

Theme Notes Copy Chapter

- Light/dark mode follows prefers-color-scheme, is toggleable from the
header, and persists in localStorage (ld-theme).
- The GitHub star count is fetched from the public GitHub API and cached in
localStorage for an hour; the button degrades to a plain link offline.
- Search is a lightweight overlay (/ or Cmd/Ctrl+K) over the standard
search plugin index — no external search dependencies.
- Mermaid diagrams render client-side; the library is loaded from a CDN only
on pages that contain a diagram.