lynsedb/mkdocs.yml at main · BirchKwok/lynsedb · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
site_name: LynseDB
site_author: Birch Kwok
site_url: https://birchkwok.github.io/LynseDB/

repo_url: https://github.com/BirchKwok/LynseDB
repo_name: birchkwok/LynseDB

theme:
  name: material
  logo: img/logo.png
  favicon: img/favicon.png
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.top
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.path
    - toc.integrate
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.select
    - content.code.annotate

  palette:

    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  font:
    text: false
    code: Roboto Mono

extra:
  paths:
    - lynse
  version:
    provider: mike

markdown_extensions:
  - sane_lists
  - toc:
      permalink: true
      permalink_class: headerlink
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

plugins:
  - search

nav:
  - Home: index.md
  - Quickstart: quickstart.md
  - Tutorials:
    - Learning path: tutorials/learning_path.md
    - Core concepts: tutorials/core_concepts.md
    - Connect and deploy: tutorials/connect_and_deploy.md
    - Databases and collections: tutorials/databases_collections.md
    - Add vectors: tutorials/add_vectors.md
    - Search and filter: tutorials/search_and_filter.md
    - Domain-aware distance metrics: tutorials/distance_metrics.md
    - Metadata filter cookbook: tutorials/metadata_filter_cookbook.md
    - Indexing guide: tutorials/indexing.md
    - Named, sparse, and hybrid search: tutorials/named_sparse_hybrid.md
    - Build a RAG workflow: tutorials/rag_workflow.md
    - Performance tuning: tutorials/performance_tuning.md
    - Backup and maintenance: tutorials/operations.md
    - Troubleshooting: tutorials/troubleshooting.md
  - Concepts:
    - Release Notes: releases.md
    - ResultView: result_view.md
    - Comparisons:
      - LynseDB vs ChromaDB and LanceDB: comparisons/chromadb_lancedb.md
      - Vector database benchmarks: comparisons/vector_database_benchmarks.md
  - API Reference:
    - Python client: client.md
    - HTTP API:
      - Server overview: http_api/serve_api/app.md
      - Database endpoints: http_api/serve_api/database_ops.md
      - Collection endpoints: http_api/serve_api/collection_ops.md
      - Python HTTP client: http_api/client_api.md
  - Deployment:
    - Cluster deployment: deployment/cluster-deployment.md