mkdocs.yml

site_name: SMS Gateway for Android™
site_url: https://docs.sms-gate.app
repo_url: https://github.com/capcom6/android-sms-gateway
site_description: Official documentation for SMS Gateway for Android
site_author: Aleksandr Soloshenko
theme:
  name: material
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.indexes
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default

      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
nav:
  - Home: index.md
  - Installation: installation.md
  - Getting Started:
      - Overview: getting-started/index.md
      - Local Server: getting-started/local-server.md
      - Public Cloud Server: getting-started/public-cloud-server.md
      - Private Server: getting-started/private-server.md
      - Custom Gateway Setup: getting-started/custom-gateway.md
      - Webhooks: getting-started/webhooks.md
  - Integration:
      - Overview: integration/index.md
      - API: integration/api.md
      - Authentication: integration/authentication.md
      - Libraries: integration/client-libraries.md
      - CLI: integration/cli.md
      - Webhooks: features/webhooks.md
      - GET to POST: integration/get-to-post.md
      - Agent Systems: integration/agents.md
  - Features:
      - Sending Messages: features/sending-messages.md
      - Reading Messages: features/reading-messages.md
      - Webhooks: features/webhooks.md
      - Status Tracking: features/status-tracking.md
      - Multi-Device Support: features/multi-device.md
      - Multi-SIM Support: features/multi-sim.md
      - MMS Support: features/mms.md
      - Data SMS Support: features/data-sms.md
      - Health Checks: features/health.md
      - Ping: features/ping.md
      - Private Server: features/private-server.md
      - Logging: features/logging.md
      - Settings Management: features/settings-management.md
  - FAQ:
      - General: faq/general.md
      - Local Server: faq/local-server.md
      - Webhooks: faq/webhooks.md
      - Reading Messages: faq/reading-messages.md
      - Errors: faq/errors.md
      - Authentication: faq/authentication.md
      - Private Server: faq/private-server.md
  - Resources:
      - Examples: resources/examples.md
      - Use Cases: resources/use-cases.md
      - Third-Party: resources/3rdparty.md
  - Services:
      - Twilio Fallback: services/twilio-fallback.md
      - Certificate Authority: services/ca.md
  - Blog: blog/index.md
  - Pricing: pricing.md
  - Privacy:
      - Policy: privacy/policy.md
      - Encryption: privacy/encryption.md
  - Contributing: contributing.md
  - License: license.md
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
plugins:
  - search
  - render_swagger
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true
      cache_safe: true
  - social:
      enabled: !ENV [CI, false]
  - git-revision-date-localized:
      enable_creation_date: true
  - blog:
      blog_dir: blog
      blog_toc: true
  - rss:
      match_path: blog/posts/.*
      date_from_meta:
        as_creation: date
      categories:
        - categories
        - tags
exclude_docs: |
  /skill.md
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.blocks.caption
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.snippets