mkdocs.yaml

# SPDX-FileCopyrightText: Copyright 2020-2023, Contributors to pocketutils
# SPDX-PackageHomePage: https://github.com/dmyersturnbull/pocketutils
# SPDX-License-Identifier: Apache-2.0

# :tyranno: site_name: "${project.name}"
site_name: "pocketutils"

# :tyranno: site_name: "${.copyright}"
copyright: Copyright 2023, Contributors to pocketutils
# :tyranno: site_name: "${project.description}"
site_description: "CI/CD example"

# Theme
theme:
  name: material
  custom_dir: docs/overrides
  features:
    - content.action.edit
    - content.code.copy
    - content.code.annotate
    - navigation.expand
    - navigation.instant
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.suggest
    - tags
    - toc.follow
    - typeset
  icon:
    logo: material/cloud
    repo: fontawesome/brands/github
  font:
    text: Noto Sans
    code: Noto Sans Mono
  static_templates:
    - 404.html
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  # :tyranno: repo_url: ${project.urls.Source}
  repo_url: https://github.com/dmyersturnbull/cicd
  extra:
    consent:
      title: Cookie consent
      description: >-
        This site uses cookies to remember your preferences and to enable analytics.
        Please indicate your consent.
      actions: [accept, reject, manager]

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - pymdownx.betterem:
      smart_enable: all
  - codehilite:
      guess_lang: false
  - def_list
  - footnotes
  - meta
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
  - pymdownx.highlight:
      guess_lang: false
      linenums_style: pymdownx-inline
      use_pygments: true
  - pymdownx.inlinehilite
  - pymdownx.keys:
  - pymdownx.mark
  - pymdownx.magiclink:
      repo_url_shortener: true
      repo_url_shorthand: true
      social_url_shortener: true
      social_url_shorthand: true
      normalize_issue_symbols: true
      provider: github
      # :tyranno: user: ${.vendor}
      user: dmyersturnbull
      # :tyranno: repo: ${project.name}
      repo: cicd
  - pymdownx.progressbar:
  - pymdownx.saneheaders
  - 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
  - smarty
  - tables
  - toc:
      permalink: true

extra_javascript:
  - javascripts/mathjax.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - javascripts/tablesort.js

plugins:
  - literate-nav:
      nav_file: SUMMARY.md
  - mike:
      canonical_version: latest
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      cache_safe: true
  - mkdocstrings:
      handlers:
        python:
          options:
            show_submodules: true
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
  #- mkdocs-section-index
  - search
  - table-reader

extra:
  version:
    provider: mike
    default: latest