site_name: PyTermGUI::docs

theme:
  name: material
  font:
    text: Open Sans

  icon:
    logo: octicons/terminal-16

  features:
    - navigation.tabs
    - content.code.annotate

  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep-purple
      accent: lime
      toggle:
        icon: material/lightbulb-outline
        name: Switch to dark mode

    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep-purple
      accent: green
      toggle:
        icon: material/lightbulb
        name: Switch to light mode

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - gen-files:
      scripts:
        - docs/gen_ref_nav.py
        - docs/gen_docstring_svgs.py

  - literate-nav:
      nav_file: SUMMARY.md

  - mkdocstrings:
      handlers:
        python:
          paths: [pytermgui]
          options:
            docstring_style: google

  - termage:
      # MkDocs Material's theme colors
      background: "#21222C"
      foreground: "#D5D7E2"


repo_url: https://github.com/bczsalba/pytermgui
repo_name: bczsalba/pytermgui

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.keys
  - pymdownx.details
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences

nav:
  - PyTermGUI:
    - Welcome: index.md

    - TIM:
      - Introduction: tim/index.md
      - Tags: tim/tags.md
      - Usage in PTG: tim/usage.md

    - Widgets:
      - 'Palettes & styling': widgets/styling.md
      - The batteries included: widgets/builtins.md
      - Attributes to know about: widgets/attrs.md
      - Create your own: widgets/custom.md

    - Inspection: inspect.md
    - 'SVG & HTML exports': exports.md

  - Walkthroughs:
    - walkthroughs/index.md

    # - Building a TUI application:
    #   - Planning: walkthroughs/tui/planning.md
    #   - Functional prototype: walkthroughs/tui/prototype.md
    #   - Styled product: walkthroughs/tui/product.md

    - Building an inline-widget context: walkthroughs/inline.md

  - Reference: reference/
  - Future: future.md

