mkdocs.yml

# Website Info
site_name: BlindAI
site_url: https://blindai.mithrilsecurity.io/en/latest/
site_author: Mithril Security

# Repository
repo_name: mithril-security/blindai
repo_url: https://github.com/mithril-security/blindai

# Configuration
theme:
  name: material
  custom_dir: docs/material_theme_customization
  features:
    - navigation.instant
    - search.highlight
    - content.tabs.link
    - navigation.sections
    - navigation.indexes
    - navigation.expand
    
  logo: assets/logo.png
  favicon: assets/logo.png
  palette:
    - scheme: slate
      toggle:
        icon: material/weather-sunny
    - scheme: default
      toggle:
        icon: material/weather-night
  icon:
    admonition:
      note: material/pencil-circle
      abstract: material/list-box-outline
      info: material/information-outline
      tip: material/fire
      success: material/check
      question: material/help-circle
      warning: material/alert
      failure: material/window-close
      danger: material/lightning-bolt-circle
      bug: material/shield-bug
      example: material/test-tube
      quote: material/format-quote-close

#Plugins
plugins:
  - search
  - mkdocs-jupyter

# Customization
extra:
  homepage: https://mithrilsecurity.io
  social:
    - icon: fontawesome/brands/discord
      link: https://discord.com/invite/TxEHagpWd4
    - icon: fontawesome/brands/github
      link: https://github.com/mithril-security/
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/mithril-security-company/
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/mithrilsecurity

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - "https://code.jquery.com/jquery-3.3.1.min.js"

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.critic

# Documentation tree
nav:
- 🏠 Home: 'index.md' 

- 🚀 Getting Started: 
  - Quick tour: 'docs/getting-started/quick-tour.ipynb'
  - How we protect your data: 'docs/getting-started/confidential_computing.md'
  - "Project structure: API & Core" : 'docs/getting-started/blindai_structure.md'

- Tutorials:
  - "BlindAI API: popular models":
    - API Overview: 'docs/tutorials/api/coming_soon.md'
    - Whisper: 'docs/tutorials/api/whisper_tutorial.ipynb'
  - "BlindAI Core: custom models":
    - Core Overview: 'docs/concepts/BlindAI_Core.md'
    - Installation: 'docs/tutorials/core/installation.md'
    - Uploading models: 'docs/tutorials/core/uploading_models.ipynb'

- 💡 Concepts:
  - Why BlindAI?: 'docs/getting-started/why-blindai.md'
  - Secure Enclaves: 'docs/concepts/SGX_vs_Nitro.md'
- 🌍 How-to-Guides:
  -  Confidential diagnosis with Covid-NET: 'docs/how-to-guides/covid_net_confidential.ipynb'

- 🛠️ Client API reference: 'blindai/client.html'

- 🔒 Security:
  - Remote attestation: 'docs/security/remote_attestation.md'
  - Threat model: 'docs/security/threat_model.md'

- ⚙️ Advanced:
  - Build from sources:
    - Client SDK: 'docs/advanced/build-from-sources/client.md'
    - Server: 'docs/advanced/build-from-sources/server.md'
  - Open source:
     - Project structure: 'docs/advanced/contributing/blindai-project-structure.md'
     - Setting-up your dev environment: 'docs/advanced/contributing/setting-up-your-dev-environment.md'
     - Contributing: "docs/advanced/contributing/contributing.md"
     - Code of Conduct: "docs/advanced/contributing/code_of_conduct.md"