mkdocs.yml

# SPDX-FileCopyrightText: 2026 Marcus Baw and Baw Medical Ltd
# SPDX-License-Identifier: AGPL-3.0-or-later

site_name: sct
site_url: https://pacharanero.github.io/sct
site_description: A fast, local-first SNOMED CT toolkit

# repo
repo_url: https://github.com/pacharanero/sct
repo_name: sct
edit_uri: edit/main/docs/

docs_dir: docs

theme:
  name: zensical
  variant: modern
  logo: assets/logo/sct-logo.svg
  favicon: assets/logo/sct-logo.svg
  features:
    - content.code.copy # Copy code snippets
    - content.action.edit # Edit this page
    - content.action.view # View source of this page
    - navigation.path # Show the current path in breadcrumbs
    - navigation.footer # Show Previous and Next links
    - navigation.instant # Enable instant navigation
    - navigation.instant.progress # Show instant navigation progress
    - navigation.expand # Expand navigation by default
    - navigation.tabs # Top-level sections as a tab bar below the header
    - navigation.tabs.sticky # Keep the tab bar visible when scrolling

  palette:
    # Follows OS preference
    - media: "(prefers-color-scheme)"
      toggle:
        icon: lucide/sun-moon
        name: Switch to light mode

    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: lucide/sun
        name: Switch to dark mode

    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: lucide/moon
        name: Switch to system preference

nav:
  - Home: index.md
  - Walkthrough:
      - Overview: walkthrough/index.md
      - Getting Started: walkthrough/getting-started.md
      - Refsets and Code Lists: walkthrough/refsets-codelists.md
      - Parquet and DuckDB: walkthrough/parquet-duckdb.md
      - Semantic Search and LLMs: walkthrough/semantic-llm.md
      - Transitive Closure Table: walkthrough/transitive-closure.md
      - Interactive UIs: walkthrough/interactive-uis.md
      - DMWB:
          - Walkthrough: dmwb/walkthrough.md
          - Read v2 via TRUD item 9: dmwb/read-v2-item9.md
      - Everything Else: walkthrough/everything-else.md
  - SDK:
      - Overview: sdk/index.md
      - Rust: sdk/rust.md
      - Python: sdk/python.md
      - Data and licensing: sdk/data-licensing.md
  - Commands:
      - Get & build:
          - sct trud: commands/trud.md
          - sct read2: commands/read2.md
          - sct ndjson: commands/ndjson.md
          - sct sqlite: commands/sqlite.md
          - sct parquet: commands/parquet.md
          - sct markdown: commands/markdown.md
          - sct embed: commands/embed.md
          - sct fst: commands/fst.md
          - sct tct: commands/tct.md
      - Search & explore:
          - sct lookup: commands/lookup.md
          - sct history: commands/history.md
          - sct sayt: commands/sayt.md
          - sct lexical: commands/lexical.md
          - sct semantic: commands/semantic.md
          - sct ecl: commands/ecl.md
          - sct diagram: commands/diagram.md
          - sct proximal-primitives: commands/proximal-primitives.md
          - sct refset: commands/refset.md
          - sct map: commands/map.md
          - sct size: commands/size.md
          - sct dmwb: commands/dmwb.md
      - Code lists:
          - sct codelist: commands/codelist.md
      - Connect & serve:
          - sct serve: commands/serve.md
          - sct mcp: commands/mcp.md
          - sct tui: commands/tui.md
          - sct gui: commands/gui.md
      - Utilities:
          - sct info: commands/info.md
          - sct diff: commands/diff.md
          - sct paths: commands/paths.md
          - sct bench: commands/bench.md
          - sct completions: commands/completions.md
  - Deploy:
      - Overview: deploy/index.md
      - Docker Image: deploy/docker-image.md
      - Build from Source: deploy/terminology-server.md
  - Reference:
      - A SNOMED CT Primer: primer.md
      - Why sct?: why/why-build-this.md
      - Why code lists?: why/why-codelists.md
      - Path Resolution: path-resolution.md
      - Android (Termux): android-termux.md
      - UK Edition Structure: uk-edition-structure.md
      - GPS and IPS Releases: gps-ips.md
      - Performance and Tuning: performance.md
      - Benchmarks: benchmarks.md
      - FHIR Conformance And Benchmarks: fhir-conformance-benchmarks.md
      - Vector Search Landscape: vector-search-landscape.md

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets:
      base_path: ["."]
      check_paths: true
  - pymdownx.emoji:
      emoji_index: !!python/name:zensical.extensions.emoji.twemoji
      emoji_generator: !!python/name:zensical.extensions.emoji.to_svg

extra_css:
  - stylesheets/extra.css