mkdocs.yml

site_name: "Akkupy | Documentations"
site_description: "I'm Akash S / Akkupy and this is a documentation website that contains docs on my projects and series. It also contains serveral tech based articles that you can check out!"
site_url: "https://docs.akkupy.com/"
repo_url: "https://github.com/akkupy/docs/"
repo_name: "akkupy/docs"

nav:
  - Home: index.md
  - About: about.md
  - Credits: credits.md
  - Posts:
    - 2023:
      - posts/unbound.md
      - posts/pop_os.md
      - posts/raid_nas_raspberrypi.md
      - posts/zvoteprod.md
      - posts/zvote.md
      - posts/vaultwarden.md
      - posts/rpimonitoring.md
      - posts/nextcloud.md
    - 2022:
      - posts/homelab.md
      - posts/tailscale.md
      - posts/nginx_proxy_manager.md
      - posts/self_ssl_cert.md
      - posts/pi-hole.md
      - posts/jellyfin.md
      - posts/filebrowser.md
      - posts/heimdall.md
      - posts/qbittorrent.md
      - posts/sonarr.md
      - posts/radarr.md
      - posts/jackett.md
      

  - Showcase:
    - Showcase Grid: showcase.md
    - Projects:
      - showcase/homelab.md
      - showcase/zvote.md
      - showcase/self_signed_ssl_certificate.md

theme:
  name: material
  favicon: https://docs.akkupy.com/assets/favicon/favicon-480x480.ico
  icon:
    admonition:
      note: fontawesome/solid/note-sticky
      abstract: fontawesome/solid/book
      info: fontawesome/solid/circle-info
      tip: fontawesome/solid/bullhorn
      success: fontawesome/solid/check
      question: fontawesome/solid/circle-question
      warning: fontawesome/solid/triangle-exclamation
      failure: fontawesome/solid/bomb
      danger: fontawesome/solid/skull
      bug: fontawesome/solid/robot
      example: fontawesome/solid/flask
      quote: fontawesome/solid/quote-left
  custom_dir: docs/templates
  logo: https://raw.githubusercontent.com/akkupy/akkupy/main/assets/favicon.ico
  features:
  - announce.dismiss
  - content.action.edit
  - content.action.view
  - content.code.annotate
  - content.code.copy
  - content.tooltips
  - navigation.footer
  - navigation.indexes
  - navigation.sections
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.top
  - search.highlight
  - search.suggest
  - toc.follow
  palette:
  - media: "(prefers-color-scheme)"
    toggle:
      icon: material/brightness-auto
      name: Switch to light mode
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: teal
    accent: purple
    toggle:
      icon: material/weather-sunny
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: black
    accent: lime
    toggle:
      icon: material/weather-night
      name: Switch to system preference

extra_css:
- css/custom.css

markdown_extensions:
- admonition
- def_list
- attr_list
- callouts
- footnotes
- md_in_html
- meta
- pymdownx.blocks.admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.emoji:
    emoji_index: !!python/name:materialx.emoji.twemoji
    emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.magiclink
- pymdownx.snippets:
    check_paths: true
    base_path: [docs/snippets, "."]
- pymdownx.highlight
- pymdownx.superfences:
    custom_fences:
    - name: mermaid
      class: mermaid
      format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
    alternate_style: true
    slugify: !!python/object/apply:pymdownx.slugs.slugify
      kwds:
        case: lower
- pymdownx.tasklist:
    custom_checkbox: true
- toc:
    permalink: "¤"

plugins:
- search
- markdown-exec
- redirects:
    redirect_maps:
      # old posts
      # 2020/06/02/unify-logging-for-a-gunicorn-uvicorn-app.md: posts/unify-logging-for-a-gunicorn-uvicorn-app.md
 

extra:
  analytics:
    provider: google
    property: G-VHR0GFBR7Q
  generator: false
  social:
  - icon: fontawesome/brands/github
    link: https://github.com/akkupy
  - icon: fontawesome/brands/mastodon
    link: https://fosstodon.org/@akkupy
  - icon: fontawesome/brands/twitter
    link: https://twitter.com/akkupy
  - icon: fontawesome/brands/linkedin
    link: https://www.linkedin.com/in/akkupy
  - icon: fontawesome/brands/discord
    link: https://discord.com/users/518054587114979338
  - icon: fontawesome/brands/docker
    link: https://hub.docker.com/u/akkupy

copyright: Copyright © 2023 - 2024 Akkupy