mkdocs.yml

site_name: Cockpitdecks Documentation

site_url: https://devleaks.github.io/cockpitdecks-docs/
repo_url: https://github.com/devleaks/cockpitdecks
site_description: Documentation for Cockpitdecks X-Plane Application and Plugin
copyright: |
  Copyright &copy; 2022 - 2025 <a href="https://github.com/devleaks"  target="_blank" rel="noopener">Pierre M</a>

# ###############################################
#
# Theme and appearance
#
theme:
  # TERMINAL:
  # name: terminal # material # Must use Material theme
  # palette: dark
  # logo: assets/images/favicon.png
  # icon:
  #   logo: assets/images/favicon.png

  name: material # Must use Material theme
  custom_dir: docs/.theme # If you have overrides, specify where to find them
  logo: assets/images/favicon.png
  icon:
    logo: assets/images/favicon.png
  palette:
    scheme: dracula # This is how to enables the Dracula theme for dark. For light, it will use default Material with some tweaks.
    primary: deep purple # Primary colors
    accent: orange # accent color
  font:
    text: Roboto
    code: Fira Mono
  features:
    - announce.dismiss
    - navigation.tabs
    - navigation.top
    - navigation.instant
    - navigation.indexes
    - toc.follow
    - content.tabs.link
    - search.share
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.code.annotations
#  Uncomment to add move and credit to mkdocs material designers
#  pymdownx:
#    sponsor: "https://github.com/sponsors/facelessuser"
#
#
#
# Dracula is a dark theme only. Dracula can't stand the light.
#
#
# ###############################################
#
# Navigation, headings, «tabs»
#
# ===============================================
#
# T A B L E   O F  C O N T E N T
#
# nav: now moved into .nav.yml file for awesome-nav plug in
#
# ===============================================
#
#
# ###############################################
#
# Plugins
#
plugins:
#  - markdown-exec # this adds ```tree representation support
  - search
  - awesome-nav
  - roamlinks
  - callouts
  - charts
  - tags
  - markmap:
      base_path: docs
      encoding: utf-8
      file_extension: .mm.md
  - mkdocstrings:
      handlers:
        python:
          paths: ["cockpitdecks"]
          options:
            # docstring_style: google
            docstring_options:
              ignore_init_summary: true
            docstring_section_style: list
            filters: public
            heading_level: 1
            inherited_members: true
            line_length: 88
            merge_init_into_class: true
            parameter_headings: true
            preload_modules: [mkdocstrings]
            relative_crossrefs: true
            scoped_crossrefs: true
            separate_signature: true
            show_bases: false
            show_inheritance_diagram: true
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            show_source: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary: true
            unwrap_annotated: true
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
      fallback_to_build_date: true
      default_handler: python


# ###############################################
#
# Extensions
#
# Note: Some extensions have been commented out because unused.
#       Restoring some extension may require added appropriate
#       python package.
#
markdown_extensions:
  - nl2br
  - markdown.extensions.toc:
      slugify: !!python/object/apply:pymdownx.slugs.slugify { kwds: { case: lower } }
      permalink: ""
  - markdown.extensions.admonition:
  - markdown.extensions.smarty:
      smart_quotes: false
  - pymdownx.betterem:
  - pymdownx.keys
  - markdown.extensions.attr_list:
  - markdown.extensions.def_list:
  - markdown.extensions.tables:
  - markdown.extensions.abbr:
  - markdown.extensions.footnotes:
  - markdown.extensions.md_in_html:
  - pymdownx.superfences:
      preserve_tabs: true
      custom_fences:
        # Mermaid diagrams
        # Please recall that fence must match Obsidian mermaid plugin
        - name: mermaid
          class: diagram
          format: !!python/name:pymdownx.superfences.fence_code_format
            # - name: math
            #   class: arithmatex
            #   format:
            #     !!python/object/apply:pymdownx.arithmatex.arithmatex_fenced_format { kwds: { mode: generic, tag: pre } }
            # - name: md-render
            #   class: md-render
            #   format: !!python/name:tools.pymdownx_md_render.md_sub_render

            # Vega Lite charts
            #
            # Please recall that fence must match Vega/Vega-Lite Obsidian
            # plugin https://github.com/Justin-J-K/obsidian-vega
            # (In above Obsidian plugin, fences cannot be changed.)


        - name: vega-lite
          class: vegalite
          format: !!python/name:mkdocs_charts_plugin.fences.fence_vegalite # Vega-Lite charts


        - name: vega
          class: vegalite
          format: !!python/name:mkdocs_charts_plugin.fences.fence_vegalite # Vega charts


  - pymdownx.highlight:
      extend_pygments_lang:
        - name: js
          lang: js
        - name: pycon3
          lang: pycon
          options:
            python3: true
      linenums_style: pymdownx-inline
  - pymdownx.inlinehilite:
      custom_inline:
        - name: math
          class: arithmatex
          format: !!python/object/apply:pymdownx.arithmatex.arithmatex_inline_format { kwds: { mode: generic } }
  - pymdownx.magiclink:
      repo_url_shortener: true
      repo_url_shorthand: true
      social_url_shorthand: true
      social_url_shortener: true
      user: facelessuser
      repo: pymdown-extensions
      normalize_issue_symbols: true
  - 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.arithmatex:
  #     generic: true
  #     block_tag: "pre"
  - pymdownx.mark:
  - pymdownx.striphtml:
  # - pymdownx.snippets:
  #     base_path:
  #       - docs/src/markdown/.snippets
  #       - LICENSE.md
  #       - SECURITY.md
  #     auto_append:
  #       - refs.md
  #     check_paths: true
  # - pymdownx.keys:
  #     separator: "\uff0b"
  - pymdownx.details:
  - pymdownx.tabbed:
      alternate_style: true
  - 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
      combine_header_slug: True
      slugify: !!python/object/apply:pymdownx.slugs.slugify { kwds: { case: lower } }
  # - tools.collapse_code:
  #     expand_text: ""
  #     collapse_text: ""


# ###############################################
#
# Extras
#
extra_javascript:
  - assets/js/extra-loader.js
  - assets/js/material-extra-3rdparty.js
  - assets/js/material-extra-theme.js
  - https://unpkg.com/mermaid/dist/mermaid.min.js
  - https://cdn.jsdelivr.net/npm/vega@5
  - https://cdn.jsdelivr.net/npm/vega-lite@5
  - https://cdn.jsdelivr.net/npm/vega-embed@6

extra_css:
  - assets/css/extra.css
  - assets/css/fonts.css
  - assets/css/dracula-colors.css
  - assets/css/image-align.css