mkdocs.yml

site_name: DBTunnel Docs
site_description: DBTunnel is a proxy solution to run elegant Web UIs natively inside databricks notebooks.

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.annotate
    - content.action.edit
    - content.action.view
    - content.tooltips
    - content.code.copy
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - navigation.expand
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

  font:
    text: Roboto
    code: Roboto Mono
  language: en

repo_name: stikkireddy/dbtunnel
repo_url: https://github.com/stikkireddy/dbtunnel
edit_uri: edit/main/docs/

plugins:
  - search:
      lang: en
  - mkdocs-jupyter:
      ignore_h1_titles: True
      include_source: True

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:materialx.emoji.to_svg
      emoji_index: !!python/name:materialx.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.snippets


nav:
  - About: index.md
  - Getting Started:
    - Setup: getting-started/setup.md
    - Gradio: getting-started/gradio.md
    - Chainlit: getting-started/chainlit-instructions.md
    - Streamlit [TBD]: getting-started/streamlit.md
    - Bokeh [TBD]: getting-started/bokeh.md
    - FastAPI [TBD]: getting-started/fastapi.md
    - Flask [TBD]: getting-started/flask.md
    - Dash [TBD]: getting-started/dash.md
    - Shiny Python [TBD]: getting-started/shiny-python.md
    - Solara [TBD]: getting-started/solara.md
    - Stable Diffusion WebUI [TBD]: getting-started/stable-diffusion-webui.md
    - Code Server [TBD]: getting-started/code-server.md
  - Architecture:
    - Overview: architecture/index.md
  - Examples: examples/index.md