OpenSift/mkdocs.yml at main · AtomInnoLab/OpenSift · 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
109
110
111
112
site_name: OpenSift
site_url: https://atominnolab.github.io/OpenSift
site_description: Open-source AI augmentation layer for search engines
site_author: OpenSift Team
repo_url: https://github.com/AtomInnoLab/OpenSift
repo_name: AtomInnoLab/OpenSift
edit_uri: edit/main/docs/

copyright: Copyright &copy; 2025 OpenSift Team — Apache License 2.0

theme:
  name: material
  language: en
  logo: assets/logo.svg
  favicon: assets/favicon.svg
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow
  palette:
    - scheme: default
      primary: indigo
      accent: deep purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: deep purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true

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
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/AtomInnoLab/OpenSift
    - icon: fontawesome/solid/globe
      link: https://wispaper.ai?utm_source=opensift
    - icon: fontawesome/solid/file-lines
      link: https://arxiv.org/abs/2512.06879

nav:
  - Home: index.md
  - Demo: demo.md
  - Getting Started:
    - Quick Start: guide/quickstart.md
    - Configuration: guide/configuration.md
  - API Reference:
    - Search API: api/search.md
    - Plan API: api/plan.md
    - Batch API: api/batch.md
    - Health API: api/health.md
  - Adapters:
    - Overview: adapters/overview.md
    - Elasticsearch: adapters/elasticsearch.md
    - OpenSearch: adapters/opensearch.md
    - Solr: adapters/solr.md
    - MeiliSearch: adapters/meilisearch.md
    - Wikipedia: adapters/wikipedia.md
    - Custom Adapter: adapters/custom.md
  - Python SDK: sdk.md
  - Architecture: architecture.md
  - Development:
    - Contributing: development/contributing.md
    - Testing: development/testing.md
  - WisModel: wismodel.md