mkdocs.yml

site_name: txn2/mcp-datahub
site_url: https://mcp-datahub.txn2.com
site_description: Composable MCP server for DataHub metadata catalogs
site_author: Craig Johnston
repo_url: https://github.com/txn2/mcp-datahub
repo_name: txn2/mcp-datahub
edit_uri: edit/main/docs/

copyright: Copyright &copy; 2025 - 2026 <a href="https://imti.co">Craig Johnston</a> / <a href="https://deasil.works">Deasil Works, Inc.</a> / <a href="https://plexara.io">Plexara</a>

theme:
  name: material
  custom_dir: docs/overrides
  logo: images/logo.png
  favicon: images/logo.png
  palette:
    scheme: slate
  font: false
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.action.edit
    - toc.follow
    - announce.dismiss

nav:
  - Home: index.md
  - Ecosystem: ecosystem/index.md
  - Getting Started: getting-started.md
  - MCP Server:
    - Overview: server/index.md
    - Installation: server/installation.md
    - Configuration: server/configuration.md
    - Tools Reference: server/tools.md
  - Go Library:
    - Overview: library/index.md
    - Quick Start: library/quickstart.md
    - Architecture: library/architecture.md
    - Composability: library/composability.md
  - Tutorials:
    - Overview: tutorials/index.md
    - Your First Search: tutorials/first-search.md
    - Exploring Lineage: tutorials/exploring-lineage.md
    - Building a Custom Server: tutorials/building-custom-server.md
    - Adding Authentication: tutorials/adding-authentication.md
  - How-To Guides:
    - Overview: guides/index.md
    - Authentication: guides/authentication.md
    - Multi-Tenant Isolation: guides/multi-tenant.md
    - Audit Logging: guides/audit-logging.md
    - Rate Limiting: guides/rate-limiting.md
    - Custom Middleware: guides/custom-middleware.md
    - Testing: guides/testing.md
  - Concepts:
    - Overview: concepts/index.md
    - Understanding URNs: concepts/urns.md
    - Entity Types: concepts/entity-types.md
    - Lineage Model: concepts/lineage-model.md
    - MCP Protocol: concepts/mcp-protocol.md
  - Examples:
    - Overview: examples/index.md
    - Basic Server: examples/basic-server.md
    - With Authentication: examples/with-authentication.md
    - Combined DataHub + Trino: examples/combined-trino.md
    - Enterprise Server: examples/enterprise-server.md
  - Reference:
    - Tools API: reference/tools-api.md
    - Configuration: reference/configuration.md
    - Security: reference/security.md
  - Support:
    - FAQ: faq.md
    - Troubleshooting: support/troubleshooting.md
    - Changelog: support/changelog.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/txn2/mcp-datahub
      name: mcp-datahub on GitHub
  generator: false

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: txn2
      repo: mcp-datahub
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'