mkdocs.yml

site_name: "Python🐍🤝🦀Rust"
site_description: "Documentation and examples that compares code blocks for Python and Rust."
site_author: "Kostiantyn Salnykov"
site_dir: "docs_build"
site_url: "https://ksalnykov.com/python_vs_rust"  # logo link
dev_addr: "localhost:9999"  # local server `HOST:PORT`
repo_url: "https://github.com/Kostiantyn-Salnykov/python_vs_rust"
repo_name: "Kostiantyn-Salnykov/python_vs_rust"  # name of Git repository
edit_uri: ""  # disable `edit` button
remote_branch: "docs"  # gh-deploy branch name
copyright: "Copyright © 2024 python_vs_rust - All rights reserved.🤣"  # Footer at bottom
index_page: "../README.md"


theme:
  name: "material"
  logo: "images/rust_python_no_bg.png"
  favicon: "images/rust_python_no_bg.png"
  icon:
    repo: "fontawesome/brands/github"  # Change icon of repo
    search: "material/text-box-search"  # Change icon of search
    alternate: "material/google-translate"  # Change icon of language translation
    annotation: "material/plus-circle-outline"  # Change icon of code annotations
  language: "en"
  locale: "en"
  palette:
    - scheme: "default"
      primary: "black"
      accent: "green"
      toggle:
        icon: "fontawesome/solid/lightbulb"
        name: "Turn OFF"
    - scheme: "slate"
      primary: "black"
      accent: "orange"
      toggle:
        icon: "fontawesome/regular/lightbulb"
        name: "Turn ON"
  font:
    text: "Robot"
    code: "Roboto Mono"
  features:
    - navigation.indexes  # remove navigation duplicates (for tabs)
    - navigation.top
#    - navigation.tabs
#    - navigation.tabs.sticky
#    - toc.integrate  # move navigation to the left
    - navigation.sections
    - navigation.expand
    - navigation.instant
    - search.suggest
    - search.share
    - search.highlight
    - content.tabs.link
    - content.code.annotate  # Use with `# (1)!` or `# (1)` (Python) OR `// (1)!` or `// (1)` (Rust)
    - content.tooltips

nav:
  - Main 🏡: index.md
  - First Steps 👣: pages/first_steps.md
  - Hello World 🌍: pages/hello_world.md
  - Printing 🖨️ & Formatting 📝: pages/printing.md
  - Data Types 🗄️: pages/types.md

plugins:
  - search:
      min_search_length: 2
      lang:
        - "en"
        - "uk"
  - macros:
      verbose: true
      on_error_fail: true
      include_dir: "docs"
  - i18n:
      reconfigure_material: true
      docs_structure: "folder"
      fallback_to_default: true
      languages:
        - locale: en
          name: "🇺🇸 - English"
          default: true
          build: true
          link: "/"
        - locale: uk
          name: "🇺🇦 - Українська"
          build: true
          link: "/uk/"
          nav_translations:
            Main 🏡: Головна 🏡
            First Steps 👣: Перші кроки 👣
            Hello World 🌍: Привіт світ 🌍
            Printing 🖨️ & Formatting 📝: Виведення 🖨️ <br>та форматування 📝
            Data Types 🗄️: Типи даних 🗄️

markdown_extensions:
  - tables
  - footnotes  # Ability to set hyperlink to bottom of page (as in Wikipedia)
  - pymdownx.tabbed  # Ability to create switchable tabs
  - pymdownx.caret  # Ability to create power by using caret ^, e.g.: H^2^O (chemical formula)
  - pymdownx.mark  # Mark text (highlight), e.g.: ==text==
  - pymdownx.tilde  # Text markers, e.g.: ~~deleted~~ OR ~sub text~
  # Add symbols, e.g.:(tm)=>™; (c)=>©; (r)=>®; c/o=>℅; +/-=>±; --> => →; <-- => ←; <--> => ↔; =/= => ≠; 1/4 => ¼ etc.; 1st 2nd etc.
  - pymdownx.smartsymbols
  - pymdownx.magiclink  # Make clickable links | emails
  # === Admonitions support
  # TYPEs: note, abstract, summary, tldr, info, tip, hind, important, success, check, done, question, help, faq,
  # warning, caution, attention, failure, fail, missing, danger, error, bug, example, quote, cite, todo
  - admonition  # e.g.: !!! <TYPE>
  - pymdownx.details  # ??? <TYPE>  (clickable admonition - accordion)
  - pymdownx.keys  # Ability to write keys, e.g.: ++ctrl+alt+delete++
  # ===
  - pymdownx.extra
  - abbr  # Ability to use abbreviations, e.g.: *[HTML]: Hyper Text Markup Language
  - attr_list  # Ability to set HTML & CSS attributes
  - meta  # Add <meta> tags to HTML
  - toc:  # Table of contents - right sidebar
      title: "On this page"
      permalink: ⚓  # change icon of anchor link
      permalink_title: "Anchor link to this section for reference"  # Tooltip message
      toc_depth: 4  # number of depth for `table of contents`
  - def_list  # add extra symbols for define lists: `-`; `*`; `+`
  - pymdownx.tasklist:  # Ability to add tasks lists with `- [x] This is checked`; `- [ ] This is not checked`
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true  # Enable horizontal tabs, e.g.: ===
  - pymdownx.highlight:
      linenums: true  # chow line numbers inside code
      guess_lang: true  # determines language automatically
      anchor_linenums: true
      line_anchors: true
      linenums_style: table
      pygments_lang_class: true
  - pymdownx.inlinehilite  # Ability to insert code line that highlighted for specified language, e.g. `#!py3 <CODE>` or `:::py3 <CODE>`
  - pymdownx.snippets:
      base_path: [ ".", "docs/src/" ]
      check_paths: true
      auto_append:
        - "docs/en/abbreviations.md"  # File for all abbreviations
  - pymdownx.superfences:  # Ability to set HTML & CSS attributes inside code blocks
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra:
  py: "🐍"
  rs: "🦀"
  pyt: "Python"
  rst: "Rust"
  python: "Python 🐍"
  rust: "Rust 🦀"
  button: '{target="_blank" .md-button .md-button--secondary}'
  link: '{target="_blank"}'
  generator: false