zensical.yml

site_name: PySpelling
site_url: https://facelessuser.github.io/pyspelling
repo_url: https://github.com/facelessuser/pyspelling
edit_uri: tree/master/docs/src/markdown
site_description: Python spell checker.
copyright: |
  Copyright &copy; 2017 - 2025 <a href="https://github.com/facelessuser" target="_blank" rel="noopener">Isaac Muse</a>

docs_dir: docs/src/markdown
theme:
  custom_dir: docs/theme
  name: material
  icon:
    logo: material/book-open-page-variant
  palette:
    # Palette toggle for system
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: deep purple
      toggle:
        icon: lucide/sun
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: deep purple
      toggle:
        icon: lucide/moon
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - announce.dismiss
    - navigation.tabs
    - navigation.top
    - navigation.instant
    - navigation.indexes
    - navigation.path
    - navigation.footer
    - toc.follow
    - content.tabs.link
    - search.share
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.tabs.link
    - content.code.annotations

nav:
  - Usage:
    - Setup &amp; Overview: index.md
    - Configuration: configuration.md
    - Spelling Pipeline: pipeline.md
    - Plugin API: api.md
  - Filters:
    - Context: filters/context.md
    - CPP: filters/cpp.md
    - HTML: filters/html.md
    - JavaScript: filters/javascript.md
    - Markdown: filters/markdown.md
    - ODF: filters/odf.md
    - OOXML: filters/ooxml.md
    - Python: filters/python.md
    - Stylesheets: filters/stylesheets.md
    - Text: filters/text.md
    - URL: filters/url.md
    - XML: filters/xml.md
  - Flow Control:
    - Wildcard: flow_control/wildcard.md
  - About:
    - Contributing &amp; Support: about/contributing.md
    - Development: about/development.md
    - Changelog: about/changelog.md
    - License: about/license.md

markdown_extensions:
  - toc:
      slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}
      permalink: ""
  - smarty:
      smart_quotes: false
  - attr_list:
  - tables:
  - abbr:
  - footnotes:
  - pymdownx.betterem:
  - pymdownx.superfences:
      preserve_tabs: true
  - pymdownx.highlight:
  - pymdownx.inlinehilite:
  - pymdownx.magiclink:
      repo_url_shortener: true
      repo_url_shorthand: true
      social_url_shorthand: true
      user: facelessuser
      repo: pyspelling
  - pymdownx.tilde:
  - pymdownx.caret:
  - pymdownx.smartsymbols:
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.escapeall:
      hardbreak: True
      nbsp: True
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.progressbar:
  - pymdownx.striphtml:
  - pymdownx.snippets:
      base_path:
      - docs/src/markdown/.snippets
      - LICENSE.md
      auto_append:
      - refs.md
  - pymdownx.keys:
      separator: "\uff0b"
  - pymdownx.saneheaders:
  - pymdownx.blocks.admonition:
      types:
      - new
      - settings
      - note
      - abstract
      - info
      - tip
      - success
      - question
      - warning
      - failure
      - danger
      - bug
      - example
      - quote
  - pymdownx.blocks.details:
      types:
      - name: details-new
        class: new
      - name: details-settings
        class: settings
      - name: details-note
        class: note
      - name: details-abstract
        class: abstract
      - name: details-info
        class: info
      - name: details-tip
        class: tip
      - name: details-success
        class: success
      - name: details-question
        class: question
      - name: details-warning
        class: warning
      - name: details-failure
        class: failure
      - name: details-danger
        class: danger
      - name: details-bug
        class: bug
      - name: details-example
        class: example
      - name: details-quote
        class: quote
  - pymdownx.blocks.html:
  - pymdownx.blocks.definition:
  - pymdownx.blocks.tab:
      alternate_style: True
      slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}
  - pymdownx.fancylists:
      inject_style: True
  - pymdownx.blocks.caption:
  - pymdownx.arithmatex:
      generic: true
      block_tag: 'pre'

extra_css:
  - assets/pymdownx-extras/extra-835c322b67.css
extra_javascript:
  - assets/pymdownx-extras/extra-loader-Ccztcqfq.js

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/facelessuser