mkdocs.yml

site_name: The tkintermd Docs
site_url: https://hreikin.github.io/tkintermd
repo_name: hreikin/tkintermd
repo_url: https://github.com/hreikin/tkintermd
copyright: MIT License
theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/toggle-switch-off-outline 
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate 
      primary: red
      accent: pink
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
plugins:
  - search
  - git-revision-date
  - mkdocstrings:
      default_handler: python
      watch:
      - tkintermd/
  - with-pdf:
      author: hreikin
      copyright: MIT
      #
      cover: true
      # back_cover: true
      cover_title: The tkintermd Documentation
      cover_subtitle: Installation, usage instructions and API reference.
      cover_logo: assets/python-logo.png
      #custom_template_path: TEMPLATES PATH
      #
      #toc_title: TOC TITLE TEXT
      #heading_shift: false
      #toc_level: 3
      #ordered_chapter_level: 2
      #excludes_children:
      #    - 'release-notes/:upgrading'
      #    - 'release-notes/:changelog'
      #
      #exclude_pages:
      #    - 'bugs/'
      #    - 'appendix/contribute/'
      #convert_iframe:
      #    - src: IFRAME SRC
      #      img: POSTER IMAGE URL
      #      text: ALTERNATE TEXT
      #    - src: ...
      #two_columns_level: 3
      #
      #render_js: true
      #headless_chrome_path: headless-chromium
      #
      output_path: pdf/tkintermd-documentation-LATEST.pdf
      #enabled_if_env: ENABLE_PDF_EXPORT
      #
      #debug_html: true
      #show_anchors: true
      #verbose: true
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/hreikin/tkintermd
      name: tkintermd @ Github
markdown_extensions:

  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true

  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  # - pymdownx.emoji:
  #     emoji_index: !!python/name:materialx.emoji.twemoji
  #     emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
nav:
  - tkintermd: 
    - About: 'README.md'
    - Contributing: 'contributing-to-tkintermd.md'
    - MIT License: 'license.md'
  - Getting Started: 'getting-started/README.md'
  - Reference:
    - Reference: 'reference/README.md'
    - Constants: 'reference/tkintermd-constants.md'
    - Lexer: 'reference/tkintermd-lexer.md'
    - TkintermdFrame: 'reference/tkintermd-frame.md'