mkdocs.yml

site_name: Miden Compiler Docs
theme:
  name: material
  features:
    - search.suggest
    - search.highlight
    - search.share
    # - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.integration
    #- navigation.tabs
    #- navigation.tabs.sticky
    - navigation.indexes
    #- navigation.sections
    - navigation.path
    - navigation.top
    - navigation.footer
    - toc.follow
    - content.code.copy
    - content.action.edit

nav:
  - Getting started: index.md
  - Usage:
      - midenc: usage/midenc.md
      - cargo miden: usage/cargo-miden.md
  - Guides:
      - Rust To WebAssembly: guides/rust_to_wasm.md
      - WebAssembly To Miden Assembly: guides/wasm_to_masm.md
      - Developing Miden programs In Rust: guides/develop_miden_in_rust.md
      - Developing Miden rollup accounts and note scripts In Rust: guides/develop_miden_rollup_accounts_and_note_scripts_in_rust.md
      - Debugging programs: usage/debugger.md
  - Compiler architecture:
      - Overview: design/overview.md
      - Supported front ends: design/frontends.md
      #- HIR:
      #- Code Generation:
      #- Testing:
  - Appendices:
      - Known limitations: appendix/known-limitations.md
      - Calling conventions: appendix/calling-conventions.md
      - Canonical ABI vs Miden ABI: appendix/canonabi-adhocabi-mismatch.md

markdown_extensions:
  - toc:
      permalink: true
      permalink_title: Link to this section
      toc_depth: 4
  - codehilite
  - markdown_include.include:
      base_path: src
  - admonition
  - footnotes
  - def_list
  - attr_list
  - abbr
  - pymdownx.tabbed
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.keys
  - pymdownx.details
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.caret
  - meta
  - smarty
  - pymdownx.extra

plugins:
  - search
  - open-in-new-tab

validation:
  absolute_links: warn

extra_javascript:
  - https://cdnjs.cloudflare.com/polyfill/v3/polyfill.min.js?version=4.8.0
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js

extra_css:
  - https://fonts.googleapis.com/icon?family=Material+Icons
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css