mkdocs.yml

site_name: Extract Favicon
site_description: Extract favicon of any website.
repo_name: alexmili/extract_favicon
repo_url: https://github.com/alexmili/extract_favicon
copyright: Copyright © 2024 Alexandre Milisavljevic
theme:
    name: material
    palette:
        - media: "(prefers-color-scheme)"
          toggle:
            icon: material/lightbulb-auto
            name: Switch to light mode
        - media: '(prefers-color-scheme: light)'
          scheme: default
          accent: amber
          toggle:
            icon: material/lightbulb
            name: Switch to dark mode
        - media: '(prefers-color-scheme: dark)'
          scheme: slate
          accent: amber
          toggle:
            icon: material/lightbulb-outline
            name: Switch to system preference
    features:
        - content.code.annotate
        - content.code.copy
        # - content.code.select
        - content.footnote.tooltips
        - content.tabs.link
        - content.tooltips
        - navigation.footer
        - navigation.indexes
        - navigation.instant
        - navigation.instant.prefetch
        # - navigation.instant.preview
        - navigation.instant.progress
        - navigation.path
        - navigation.tabs
        - navigation.tabs.sticky
        - navigation.top
        - navigation.tracking
        - search.highlight
        - search.share
        - search.suggest
        - toc.follow

    # Icon to use for repo_url on top right
    icon:
        repo: fontawesome/brands/github-alt

extra:
    social:
        - icon: fontawesome/brands/github-alt
          link: https://github.com/alexmili/extract_favicon
        - icon: fontawesome/brands/linkedin
          link: https://www.linkedin.com/in/amili
plugins:
    search:
    mkdocstrings:
        handlers:
            python:
                options:
                    show_source: false
                    show_root_heading: false
                    show_if_no_docstring: false
                    show_root_toc_entry: false
                    filters: ["!^_"]
                    members_order: source
nav:
- Extract Favicon: index.md
- reference.md

markdown_extensions:
    # Python Markdown
    abbr:
    attr_list:
    footnotes:
    md_in_html:
    tables:
    toc:
        permalink: true

    # Python Markdown Extensions
    pymdownx.betterem:
    pymdownx.caret:
    pymdownx.highlight:
        line_spans: __span
    pymdownx.inlinehilite:
    pymdownx.keys:
    pymdownx.mark:
    pymdownx.superfences:
        custom_fences:
            - name: mermaid
              class: mermaid
              format: !!python/name:pymdownx.superfences.fence_code_format
    pymdownx.tilde:

    # pymdownx blocks
    pymdownx.blocks.admonition:
        types:
            - note
            - attention
            - caution
            - danger
            - error
            - tip
            - hint
            - warning
            # Custom types
            - info
            - check
    pymdownx.blocks.details:
    pymdownx.tabbed:
        alternate_style: true