copyright: "© Gugulethu Hlekwayo. All rights reserved."

exclude_docs: |
  includes/
  overrides/
  readme.md

extra:
  generator: false

extra_css:
  - src/stylesheets/g.css

markdown_extensions:
  # Allows showing additional content on hover for glossaries. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/?h=abbr#abbreviations]
  - abbr
  # Allows the use of admonitions. [https://squidfunk.github.io/mkdocs-material/reference/admonitions/#admonitions]
  - admonition
  # Attribute lists. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/?h=attr+list#attribute-lists]
  - attr_list
  # Allows creating footonotes. [https://squidfunk.github.io/mkdocs-material/reference/footnotes/?h=footnotes#footnotes]
  - footnotes
  # Write Markdown in HTML. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#markdown-in-html]
  - md_in_html
  # Improves handling of emphasis in MarkDown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=bet#betterem]
  - pymdownx.betterem:
      smart_enable: all
  # Add captions to any block of content. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caption]
  - pymdownx.blocks.caption
  # Enable carets in MarkDown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=bet#betterem]
  - pymdownx.caret
  # Add editing marks in the text using Markdown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#critic]
  - pymdownx.critic
  # Makes admonitions collapsible. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#details]
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator:
        !!python/name:material.extensions.emoji.to_svg # Allows code block highlighting. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=highlig#highlight]
  - pymdownx.highlight
  # Built on pymdownx.highlight. Allows highlighting inline code. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=inline#inlinehilite]
  - pymdownx.inlinehilite
  # Add keyboard keys in Markdown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=inline#keys]
  - pymdownx.keys
  # Allows highlight text in MarkDown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=bet#betterem]
  - pymdownx.mark
  # Add smart symbols, like copyright, in MarkDown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=smartsym#smartsymbols]
  - pymdownx.smartsymbols
  # Embed content and show it as a tooltip, liek for the definitions. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=smartsym#snippets]
  - pymdownx.snippets:
      auto_append:
        - includes/definitions.md # Path to definitions that appear in windows in the text.
  # Used to target Mermaid diagrams for rendering. [https://squidfunk.github.io/mkdocs-material/upgrade/?h=superfen#pymdownxsuperfences]
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format:
            !!python/name:mermaid2.fence_mermaid_custom # Allows creating content tabs. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=tabb#tabbed]
  - pymdownx.tabbed:
      alternate_style: true # This is the supported style. Works better on mobile view.
  # Render tasklists with custom icons. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=taskl#tasklist]
  - pymdownx.tasklist:
      custom_checkbox: true
  #Allows tildes in MarkDown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=bet#betterem]
  - pymdownx.tilde
  - toc:
      permalink: false
      toc_depth: 2

nav:
  - Homepage: index.md
  # - Writing: writing.md
  # - Visual: visual.md
  # - Technical:
  #     - technical.md
  #     - Qself:
  #         - qself/qself.md
  #         - Getting started: qself/getting-started.md
  #         - Finances: qself/finances.md
  #         - Transactions: qself/transactions.md
  #         - Reference: qself/reference/index.md
  #         - Devices: qself/devices.md
  - Resumé: resume.md

plugins:
  # Plugin to enable the blog feature. [https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#built-in-blog-plugin]
  - blog
  # Plugin to display a lightbox for clicked images. [https://github.com/Blueswen/mkdocs-glightbox]
  - glightbox:
      background: white
      shadow: false
      width: 100%
      height: auto
      slide_effect: fade
      manual: true
  # Plugin to use variables and macros across the docs. [https://github.com/fralau/mkdocs-macros-plugin]
  - macros:
      on_undefined: strict
      include_yaml:
        - snippets: docs/includes/snippets.yml
  # Plugin to display mermaid diagrams. [https://mkdocs-mermaid2.readthedocs.io/en/latest/]
  - mermaid2
  # Plugin that minifies all HTML, CSS, and JS files. [https://github.com/byrnereese/mkdocs-minify-plugin]
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true
      cache_safe: true
  # Plugin to self-host external assets and for link attributes. [https://squidfunk.github.io/mkdocs-material/plugins/privacy/]
  # - privacy:
  #     assets_fetch: true
  - search
  # Plugin to create index pages for each section. [https://github.com/oprypin/mkdocs-section-index]
  - section-index
  - tags

repo_name: gugulet-hu/gugulet.hu

repo_url: https://codeberg.com/gugulethu/gugulet-hu

site_author: Gugulethu Hlekwayo (https://codeberg.org/gugulethu)

site_description: The personal website of Gugulethu Hlekwayo.

site_name: Gugulethu Hlekwayo

site_url: "https://gugulet.hu"

theme:
  # Folder where there are files that override aspects of the site.
  custom_dir: docs/overrides/
  # Link to the favicon image file.
  favicon: src/gugulet.hu-site-logo-350x350.png
  features:
    - content.action.edit # Edit page directly from the GitHub link iun the top-right.
    - content.code.annotate # Annotate code blocks.
    - content.code.copy # Copy code blocks.
    - content.code.select # Select code range in blocks (*).
    - navigation.expand # Expand the navigation by default.
    - navigation.path # Add breadcrumbs to the top of the article.
    - navigation.prune # Only the visible pages are in the menu.
    - navigation.tabs # Tabs at the top for the chapters (i.e Platform Admin, Platform Tools, ...).
    - navigation.tracking # Address bar updated with active anchor.
    - navigation.top # Back to the top button on every page.
    - navigation.footer # Previous and next buttons in the footer.
    - search.highlight # Highlight the search item in the page.
    - search.suggest # Suggest search results.
    - search.share # Deep-link to a search results page.
  font: false
  icon:
    annotation: material/plus-circle-outline
  language: en
  logo: src/gugulet.hu-site-logo-350x350.png
  name: material
  palette:
    scheme: default
    primary: custom
    accent: custom

# Properties to validate and return messages for in the build process.
validation:
  nav:
    absolute_links: ignore
    not_found: warn
    omitted_files: ignore