mkdocs.yml

# Example: https://github.com/squidfunk/mkdocs-material/blob/master/mkdocs.yml

# project info
site_name: pycli
site_url: https://pycli.repos.brettfitz.me/dev/
site_author: Brett Fitzpatrick

# repository
repo_name: brett-fitz/pycli
repo_url: https://github.com/brett-fitz/python-cli/

# config
theme:
  logo: img/logo.png
  favicon: img/logo.png
  name: material
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections

# plugins
plugins:
  # Features and functionality
  - search
  - table-reader

  # Auto-generate reference pages
  - mkdocstrings
  - section-index
  - gen-files:
      scripts:
        - scripts/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md

  # Styling
  - minify:
      minify_html: true

# extensions
markdown_extensions:
  - attr_list
  - admonition
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true 

# navigation
nav:
  - Home: index.md
  - Setup: setup.md
  - Overview: overview.md
  - Code Reference: reference/