mkdocs.yml

site_name: Fast Dash
site_description: Fast Dash is a Python module that makes the development of web applications fast and easy. It can build web interfaces for Machine Learning models or to showcase any proof of concept without the hassle of developing UI from scratch.
site_author: Kedar Dabhadkar
site_url: https://docs.fastdash.app
copyright: "Copyright © 2022 - 2023 Kedar Dabhadkar"

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - attr_list
  - md_in_html
  - abbr
  - pymdownx.snippets

theme:
  name: material
  logo: assets/favicon.ico
  favicon: assets/favicon.ico
  icon:
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16

  features:
    - navigation.tracking
    - navigation.instant
    
repo_name: fast_dash
repo_url: https://github.com/dkedar7/fast_dash

nav:
  - Home: index.md
  - Installation: installation.md
  - Quickstart: quickstart.md
  - User guide:
    - 1. 10 minutes to Fast Dash: User guide/build.md
    - 2. Usage patterns: User guide/patterns.md
    - 3. Fast Components: User guide/components.md
    - 4. Deployment: User guide/deployment.md
  - Examples:
    - 1. Simple text to text: Examples/01_simple_text_to_text.ipynb
    - 2. Translate to multiple languages: Examples/02_translate_to_multiple_languages.ipynb
    - 3. Chat over documents with Embedchain: Examples/03_chat_over_documents.ipynb
    - 4. US land cover map with Geemap: Examples/04_land_cover_map_with_geemap.ipynb
    - 5. Global map of water indices with Geemap: Examples/05_water_indices_with_spyndex.ipynb
  - Modules: api.md
  - Contributing: contributing.md
  - Authors: authors.md
  - History: history.md

plugins:
  - mkdocs-jupyter:
      execute: false
  - include-markdown
  - search:
      lang: en
  - mkdocstrings:
      handlers:
          python:
              setup_commands:
                  - import sys
                  - sys.path.append('../')
              selection:
                  new_path_syntax: true

extra_css:
  - css/termynal.css
  - css/custom.css

extra_javascript:
  - js/termynal.js
  - js/custom.js

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/dkedar7/
    - icon: fontawesome/brands/medium
      link: https://dkedar7.medium.com/
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/dkedar7/
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/dkedar7/