site_name: Radixor
site_description: Learned transformation stemming with compiled patch-command tries for Java and Python
site_url: https://leogalambos.github.io/Radixor/
repo_url: https://github.com/leogalambos/Radixor
repo_name: leogalambos/Radixor
copyright: "© 2026 Egothor · Radixor software is BSD-3-Clause licensed."

theme:
  name: material
  language: en
  custom_dir: docs/overrides
  logo: assets/images/radixor-logo.png
  favicon: assets/images/radixor-logo.png
  features:
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
  palette:
    - scheme: default
      primary: white
      accent: blue

extra:
  generator: false

extra_css:
  - assets/stylesheets/extra.css
  - assets/stylesheets/landing-v2.css
  - assets/stylesheets/radixor-docs-safety.css

extra_javascript:
  - https://unpkg.com/mermaid@11/dist/mermaid.min.js
  - assets/javascripts/mermaid.js

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - tables

nav:
  - Home: index.md

  - Start:
     - Choose a Runtime: getting-started.md
     - Why Radixor Is Different: why-radixor-is-different.md
     - Python Fast Track: python/fast-track.md
     - Java Fast Track: fast-track.md
     - Python Quick Start: python/quick-start.md
     - Java Quick Start: quick-start.md

  - Java:
     - Integration Deep Dive: integration-deep-dive.md
     - Overview: programmatic-usage.md
     - Model Selection and Loading: model-selection-and-loading.md
     - Loading and Building Stemmers: programmatic-loading-and-building.md
     - Querying and Ambiguity Handling: programmatic-querying-and-ambiguity.md
     - Extending and Persisting Compiled Tries: programmatic-extending-and-persistence.md
     - Migration and Backward Compatibility: migration-and-backward-compatibility.md
     - CLI Compilation: cli-compilation.md

  - Python:
     - Fast Track: python/fast-track.md
     - Quick Start: python/quick-start.md
     - Overview: python/index.md
     - Installation and Builds: python/installation.md
     - Usage and API: python/usage.md
     - Dictionary Compilation: python/model-compilation.md
     - Benchmarks: python/performance.md

  - Dictionaries and Languages:
     - Stemmer Models: stemmer-models.md
     - Published Model Catalog: stemmer-model-catalog.md
     - Built-in Languages: built-in-languages.md
     - Dictionary Format: dictionary-format.md
     - Contributing Dictionaries: contributing-dictionaries.md

  - Architecture and Semantics:
     - Technology and Lineage: technology-lineage.md
     - Overview: architecture-and-reduction.md
     - Architecture: architecture.md
     - Reduction Semantics: reduction-semantics.md
     - Lookup Edge Optimization: lookup-edge-optimization.md
     - Compatibility and Guarantees: compatibility-and-guarantees.md

  - Benchmarks:
     - How to Read Benchmarks: benchmarking.md
     - Benchmark Results: benchmarks/index.md
     - Reference:
        - Methodology: benchmarks/reference/methodology.md
        - Linguistic Quality Methodology: benchmarks/reference/linguistic-quality.md
        - Tested Stemmers: benchmarks/reference/tested-stemmers.md
        - Reproducibility and Raw Data: benchmarks/reference/reproducibility.md
        - Corpora: benchmarks/reference/corpora.md
        - Environment and Reports: benchmarks/reference/environment.md
        - English Dictionary Coverage: benchmarks/reference/english-coverage.md
        - Candidate Evaluation: benchmarks/reference/candidates.md
     - Language Results:
        - Overview: benchmarks/languages/index.md
        - Czech: benchmarks/languages/czech.md
        - Danish: benchmarks/languages/danish.md
        - Dutch: benchmarks/languages/dutch.md
        - English: benchmarks/languages/english.md
        - Finnish: benchmarks/languages/finnish.md
        - French: benchmarks/languages/french.md
        - German: benchmarks/languages/german.md
        - Hebrew: benchmarks/languages/hebrew.md
        - Hungarian: benchmarks/languages/hungarian.md
        - Italian: benchmarks/languages/italian.md
        - Norwegian Bokmal: benchmarks/languages/norwegian-bokmal.md
        - Norwegian Nynorsk: benchmarks/languages/norwegian-nynorsk.md
        - Persian: benchmarks/languages/persian.md
        - Polish: benchmarks/languages/polish.md
        - Portuguese: benchmarks/languages/portuguese.md
        - Russian: benchmarks/languages/russian.md
        - Spanish: benchmarks/languages/spanish.md
        - Swedish: benchmarks/languages/swedish.md
        - Ukrainian: benchmarks/languages/ukrainian.md
        - Yiddish: benchmarks/languages/yiddish.md

  - Quality and Operations:
     - Quality and Operations: quality-and-operations.md
     - Stemming Quality: stemming-quality.md
     - Reports: reports.md
     - Historical Builds: builds.md
     - Test taxonomy and execution filtering: test-taxonomy-and-filtering.md