mkdocs.yaml

site_name: Mnemocards Docs
site_url: https://guiferviz.com/mnemocards
site_author: guiferviz
repo_url: https://github.com/guiferviz/mnemocards
repo_name: Mnemocards
strict: true

theme:
    name: material
    language: en
    features:
      # - navigation.indexes  # Use index.md as section page.
      # - navigation.tabs
      # - navigation.tabs.sticky  # Always show tabs.
      # - header.autohide
      # - navigation.sections  # Expand sections 1 level.
      # - content.code.annotate
      # - content.tabs.link
      - navigation.expand  # Expand sections automatically.
      - navigation.instant  # Load content without fully reloading the page.
      - navigation.top  # Back to top bottom
      # - navigation.tracking
      # - search.highlight
      # - search.share
      # - search.suggest
      # - toc.follow
    palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: amber
      accent: amber
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: amber
      accent: amber
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

plugins:
    - section-index  # index.md in subfolders.
    - tags:
        tags_file: tags.md
    - search
    - macros:
        include_dir: docs/include
        on_error_fail: true
        module_name: docs/macros
    - mkdocstrings:
        default_handler: python
        handlers:
          python:
            options:
              show_source: true
              show_if_no_docstring: false
              docstring_style: google

markdown_extensions:
    - mnemocards_essentials.markdown_card_extension
    - meta
    # Code highlight.
    - pymdownx.highlight:
        anchor_linenums: true
    - pymdownx.inlinehilite
    - pymdownx.snippets
    # MathJax with some options in the extra_javascript.
    - pymdownx.arithmatex:
        generic: true
    # Mermaid plots.
    - pymdownx.superfences:
        custom_fences:
            - name: mermaid
              class: mermaid
              format: !!python/name:pymdownx.superfences.fence_code_format
    # Tabs.
    - pymdownx.tabbed:
        alternate_style: true
    # Emoji.
    - attr_list
    - pymdownx.emoji:
        emoji_index: !!python/name:materialx.emoji.twemoji
        emoji_generator: !!python/name:materialx.emoji.to_svg
    # Task lists with checkboxes.
    - pymdownx.tasklist:
        custom_checkbox: true
    # Superfences admonition.
    - admonition
    - pymdownx.details
    - md_in_html
    # Cross out text using ~~text~~.
    - pymdownx.tilde

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

extra_css:
  - css/mkdocstrings.css
  - css/mnemocards.css

extra:
  generator: false
  analytics:
    provider: google
    property: G-NCB5QMMEKH
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/guiferviz
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/in/guiferviz
    - icon: fontawesome/brands/github
      link: https://github.com/guiferviz

nav:
    - Overview: index.md
    - FAQ: faq.md
    - Examples:
      - 'examples/index.md'
      - examples/custom_anki_note.md
      - examples/markdown_card_fence.md
      - examples/plugins.md
      - examples/pronunciation.md
    - API:
      - mnemocards: apis/mnemocards.md
      - mnemocards_anki: apis/mnemocards_anki.md
      - mnemocards_essentials: apis/mnemocards_essentials.md
    - Changes: changelog.md
    - Contributing: contributing.md