mkdocs.yml

site_name: MFS
site_description: "Multi-source File-like Search for agents and developers, powered by Milvus"
site_url: https://zilliztech.github.io/mfs/

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/logo.svg
  palette:
    scheme: slate
    primary: custom
    accent: custom
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - search.highlight
    - content.code.copy
  font:
    text: JetBrains Mono
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github

extra_css:
  - stylesheets/terminal.css

repo_url: https://github.com/zilliztech/mfs
repo_name: zilliztech/mfs

nav:
  - Getting started:
    - Overview: index.md
    - Why MFS: why.md
    - Quickstart: getting-started.md
    - Examples: examples.md
  - Concepts:
    - Architecture: architecture.md
    - Design philosophy: production.md
    - One model, many sources: one-model-many-sources.md
    - Robustness: robustness.md
    - Search and browse: search-and-browse.md
    - Ingest pipeline: ingest-pipeline.md
    - Schema design: schema.md
    - Caching: caching.md
  - Connectors:
    - Overview: connectors.md
    - file: connectors/file.md
    - web: connectors/web.md
    - github: connectors/github.md
    - postgres: connectors/postgres.md
    - mysql: connectors/mysql.md
    - mongo: connectors/mongo.md
    - slack: connectors/slack.md
    - discord: connectors/discord.md
    - gmail: connectors/gmail.md
    - notion: connectors/notion.md
    - jira: connectors/jira.md
    - linear: connectors/linear.md
    - zendesk: connectors/zendesk.md
    - hubspot: connectors/hubspot.md
    - bigquery: connectors/bigquery.md
    - snowflake: connectors/snowflake.md
    - s3: connectors/s3.md
    - gdrive: connectors/gdrive.md
    - feishu: connectors/feishu.md
  - Operations:
    - Configuration: configuration.md
    - Auth and secrets: auth-and-secrets.md
    - Providers and processing: providers.md
    - Deployment: deployment.md
    - Storage and backup: storage-and-backup.md
    - Troubleshooting: troubleshooting.md
  - Reference:
    - CLI: cli.md
    - HTTP API: api.md
    - SDKs: sdks.md
    - Agent skills: skills.md
    - Error codes: errors.md
    - Glossary: glossary.md
  - Project:
    - Evaluation: evaluation.md
    - Development: development.md
    - Server internals: server.md
    - FAQ: faq.md
    - Status and limits: roadmap.md

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
  - attr_list
  - md_in_html
  - toc:
      permalink: true