lance/docs/mkdocs.yml at main · fangbo/lance · 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
site_name: Lance
site_description: "Documentation for Lance, an open lakehouse format for Multimodal AI"
site_url: https://lance.org/
docs_dir: src

repo_name: lance-format/lance
repo_url: https://github.com/lance-format/lance

# Custom theme implementing the "Lance Docs" design (see theme/).
theme:
  name: null
  custom_dir: theme
  locale: en
  static_templates:
    - 404.html

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      # Allow snippets to pull in files from the repo root (e.g. shared docs
      # kept alongside Rust source). Paths are relative to the docs/ dir.
      base_path:
        - .
        - ..
  - pymdownx.tabbed:
      alternate_style: true
  # Autolink bare URLs (e.g. repository tables on the community pages).
  - pymdownx.magiclink
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

plugins:
  - search
  - awesome-pages
  - mkdocs_protobuf:
      proto_dir: ../protos

copyright: © 2025 Lance Format. All rights reserved.