mkdocs.yml

site_name: CCProxy API
site_description: A reverse proxy to api.anthropic.com that leverages your Claude subscription through the official claude-code-sdk
site_url: https://caddyglow.github.io/ccproxy-api
repo_url: https://github.com/CaddyGlow/ccproxy-api
repo_name: CaddyGlow/ccproxy-api
edit_uri: edit/main/docs/

# Theme configuration
theme:
  name: material
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - content.action.edit
    - content.action.view
    - navigation.footer

  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye
    logo: material/robot

# Navigation structure
nav:
  - Home: index.md
  - Getting Started:
    - Quick Start: getting-started/quickstart.md
    - Installation: getting-started/installation.md
    - Configuration: getting-started/configuration.md
  - Plugin System:
    - Overview: PLUGIN_SYSTEM_DOCUMENTATION.md
    - Authoring Guide: PLUGIN_AUTHORING.md
    - Credential Balancer: plugins/credential-balancer.md
    - OAuth Integration: OAUTH_PLUGIN_ARCHITECTURE.md
  - Migration:
    - 0.2 Plugin‑First: migration/0.2-plugin-first.md
  - User Guide: user-guide/
  - Development:
    - Documentation Guide: documentation-guide.md
    - Auth Providers: development/auth-providers.md
    - Debugging Guide: development/debugging-with-proxy.md
    - Formatter Refactor Plan: development/formatter-refactor-plan.md
    - Formatter Refactor Progress: development/formatter-refactor-progress.md
  - Deployment:
    - SystemD Setup: systemd-setup.md
    - Metrics API: metrics-api.md
  - Examples: examples.md
  - Contributing: contributing.md
  - Release Prep:
    - Release Status: release-v0.2-status.md
    - Open Items: v0.2-release-open-items.md
  - Code Reference: reference/

# Plugins
plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - section-index
  - gen-files:
      scripts:
        - docs/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - mkdocstrings:
      enabled: !ENV [ENABLE_MKDOCSTRINGS, true]
      default_handler: python
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
            - https://docs.pydantic.dev/latest/objects.inv
            - https://fastapi.tiangolo.com/objects.inv
          paths: [ccproxy]
          options:
            docstring_style: google
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            show_submodules: false
            show_source: true
            show_root_heading: true
            show_root_toc_entry: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            separate_signature: true
            heading_level: 2
            members_order: source
            filters:
              - "!^_"
              - "!__init__"
  - mermaid2:
      arguments:
        theme: |
          ^(light|dark|auto)$
  - minify:
      minify_html: !ENV [MKDOCS_MINIFY_HTML, false]
      minify_js: !ENV [MKDOCS_MINIFY_JS, false]
      minify_css: !ENV [MKDOCS_MINIFY_CSS, false]
      htmlmin_opts:
        remove_comments: true
      cache_safe: true

# Markdown extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      permalink_title: Anchor link to this section for reference
  - tables
  - 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:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: CaddyGlow
      repo: ccproxy-api
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      base_path: .
      auto_append:
        - includes/abbreviations.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Extra configuration
extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/CaddyGlow/claude-code-proxy-api
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/ccproxy-api/

# Development server
dev_addr: '127.0.0.1:8080'

# Watch additional files
watch:
  - ccproxy/
  - README.md
  - CHANGELOG.md
  - CONTRIBUTING.md

# Extra CSS and JavaScript
extra_css:
  - assets/extra.css

extra_javascript:
  - assets/extra.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

# Validation
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

# Copyright
copyright: Copyright © 2024 CCProxy Contributors