mkdocs.yml

site_name: CipherIQ Portal
site_description: CipherIQ products website
site_url: https://docs.cipheriq.io/

docs_dir: docs
site_dir: site

theme:
  name: material
  custom_dir: overrides
  logo: assets/cipheriq_icon_reversed_512.png
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
  palette:
    - scheme: default
      primary: custom
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: custom
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - glightbox:
      touchNavigation: true   # Swipe on mobile
      loop: true              # Loop back to first image
      effect: zoom            # Nice zoom-in effect
      slide_effect: slide     # Carousel-like slide transition
      width: 100%             # Full width in lightbox
      height: auto
      zoomable: true
      draggable: true
      auto_caption: true      # Use alt text as caption (recommended)
      caption_position: bottom
  
markdown_extensions:
  - admonition
  - codehilite
  - pymdownx.superfences:
      custom_fences:
        - class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
          name: mermaid
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - toc:
      permalink: true
  - attr_list
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      url_download: true   # Enables remote URLs (critical!)
      # Optional safety limits (recommended for large files)
      url_max_size: 2048576  # 2MB max
      url_timeout: 30


nav:
  - Home: index.md
  - CBOM Generator:
    - cbom-generator/index.md
    - Getting Started:
      - cbom-generator/getting-started/index.md
      - Installation: cbom-generator/getting-started/installation.md
      - Quick Start: cbom-generator/getting-started/quick-start.md
    - CLI Reference:
      - cbom-generator/cli-reference/index.md
      - Output Options: cbom-generator/cli-reference/output-options.md
      - Privacy Options: cbom-generator/cli-reference/privacy-options.md
      - Display Options: cbom-generator/cli-reference/display-options.md
      - Performance Options: cbom-generator/cli-reference/performance-options.md
      - Deduplication: cbom-generator/cli-reference/deduplication-options.md
      - Service Discovery: cbom-generator/cli-reference/service-discovery.md
      - Crypto Registry: cbom-generator/cli-reference/crypto-registry.md
      - Attestation: cbom-generator/cli-reference/attestation-options.md
    - Features:
      - cbom-generator/features/index.md
      - Asset Discovery: cbom-generator/features/asset-discovery.md
      - Key Material Detection: cbom-generator/features/key-material-detection.md
      - Service Dependencies: cbom-generator/features/service-dependencies.md
      - Protocol Properties: cbom-generator/features/protocol-properties.md
      - PQC Classification: cbom-generator/features/pqc-classification.md
      - Relationship Graph: cbom-generator/features/relationship-graph.md
      - Privacy Controls: cbom-generator/features/privacy-controls.md
      - Deduplication: cbom-generator/features/deduplication.md
    - Output Format:
      - cbom-generator/output/index.md
      - Components: cbom-generator/output/components.md
      - PQC in CBOM: cbom-generator/features/pqc-cbom.md
      - Crypto Properties: cbom-generator/output/crypto-properties.md
      - Namespaced Properties: cbom-generator/output/namespaced-properties.md
      - Dependencies: cbom-generator/output/dependencies.md
      - Relationships: cbom-generator/output/relationships.md
    - Playbooks:
      - cbom-generator/playbooks/index.md
      - OpenSSH PQC Migration: cbom-generator/playbooks/migrating-openssh.md
      - TLS Upgrade: cbom-generator/playbooks/tls-upgrade.md
      - Certificate Rotation: cbom-generator/playbooks/certificate-rotation.md
      - FIPS Compliance: cbom-generator/playbooks/fips-compliance.md
    - Troubleshooting:
      - cbom-generator/troubleshooting/index.md
      - No Components Found: cbom-generator/troubleshooting/no-components-found.md
      - Permission Errors: cbom-generator/troubleshooting/permission-errors.md
      - Performance Tuning: cbom-generator/troubleshooting/performance-tuning.md
      - Non-Deterministic Output: cbom-generator/troubleshooting/non-deterministic-output.md
    - Advanced:
      - cbom-generator/advanced/index.md
      - Comparing CBOMs: cbom-generator/advanced/comparing-cboms.md
      - Filtering Output: cbom-generator/advanced/filtering-output.md
      - Generating Reports: cbom-generator/advanced/generating-reports.md
      - Container Scanning: cbom-generator/advanced/container-scanning.md
      - Cross-Architecture Scanning: cbom-generator/advanced/cross-architecture.md
    - Reference:
      - CLI Syntax: cbom-generator/reference/cli-syntax.md
      - Output Format: cbom-generator/reference/output-format.md
    - About:
      - What's New: cbom-generator/about/whats-new.md
      - Best Practices: cbom-generator/about/best-practices.md
      - Support: cbom-generator/about/support.md
  - CBOM Explorer:
    - cbom-explorer/index.md
  - Crypto Tracer: 
    - crypto-tracer/index.md
    - Getting Started: 
      - Installation: crypto-tracer/03-installation.md
      - Quick Start: crypto-tracer/02-getting-started.md
    - Core Concepts:
      - Basic Concepts: crypto-tracer/04-basic-concepts.md
      - Commands Reference: crypto-tracer/05-commands-reference.md   
    - Practical Usage:
      - Common Use Cases: crypto-tracer/06-common-use-cases.md
      - Output Formats: crypto-tracer/07-output-formats.md
      - Filtering and Options: crypto-tracer/08-filtering-options.md
      - Privacy and Security: crypto-tracer/09-privacy-security.md
    - Advanced Topics:
      - Troubleshooting: crypto-tracer/10-troubleshooting.md
      - Advanced Usage: crypto-tracer/11-advanced-usage.md
      - Performance: crypto-tracer/12-performance.md
      - Integration: crypto-tracer/13-integration.md
    - Reference & Support:
      - FAQ: crypto-tracer/14-faq.md
      - Support and Resources: crypto-tracer/15-support.md
  - PQC Flow:
    - pqc-flow/index.md
    - Getting Started:
      - Installation: pqc-flow/getting-started/installation.md
      - Quick Start: pqc-flow/getting-started/quick-start.md
    - Usage:
      - Command-Line Reference: pqc-flow/usage/cli-reference.md
      - Understanding Output: pqc-flow/usage/output-format.md
      - Protocol Coverage: pqc-flow/usage/protocols.md
    - Operations: 
      - Use Cases & Workflows: pqc-flow/operations/workflows.md
      - Deployment: pqc-flow/operations/deployment.md
      - Troubleshooting: pqc-flow/operations/troubleshooting.md
    - Reference:
      - Reference Tables: pqc-flow/reference/tables.md
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/CipherIQ

copyright: Copyright © 2026 Graziano Labs Corp.