mkdocs.yml

# Project information
site_name: Under the Hood
site_url: https://luci-mg.github.io/Under-the-Hood
site_author: Mrudhul Guda
site_description: >-
  Dive deep into tech with in-depth explorations of patterns, languages, distributed systems, databases, their concepts and more all in one place.

# Repository
repo_url: https://github.com/Luci-MG/Under-the-Hood
repo_name: Luci-MG/Under-the-Hood
edit_uri: edit/main/docs/

# Copyright
copyright: Copyright © 2024 Mrudhul Guda

# Configuration
theme:
  name: material
  custom_dir: material/overrides
  features:
    - announce.dismiss
    - content.action.edit
    # - content.action.view
    - content.code.annotate
    - content.code.copy
    # - content.code.select
    # - content.footnote.tooltips
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.path
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    # - navigation.instant.prefetch
    - navigation.instant.progress
    # - navigation.prune
    # - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate
  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: teal
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to system preference
  font:
    text: Noto Sans Oriya
    code: Noto Sans Mono
  favicon: assets/favicon.png
  logo: assets/favicon.png
  icon:
    edit: material/pencil 
    view: material/eye
    # repo: fontawesome/brands/github

# plugins
plugins:
  - blog
  # - social
  # - optimize
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  # - minify:
  #     minify_html: true
  - git-revision-date-localized:
      enable_creation_date: true
      type: date
  - git-committers:
      repository: Luci-MG/Under-the-Hood
      branch: main
      enabled: !ENV [CI, false]
  # - git-authors

# Additional configuration
extra:
  status:
    new: Recently added
    deprecated: Deprecated
  # analytics:
  #   provider: google
  #   property: !ENV GOOGLE_ANALYTICS_KEY
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Luci-MG
    - icon: fontawesome/brands/linkedin-in
      link: https://linkedin.com/in/mrudhul-guda
    - icon: fontawesome/brands/instagram
      link: https://www.instagram.com/_m._._.g/
    # - icon: fontawesome/brands/facebook-f
    #   link: https://facebook.com/lucifer.iitbbs
  extra:
  version:
    provider: mike

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      title: On this page
      toc_depth: 3
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/mkdocs.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      # slugify: !!python/object/apply:pymdownx.slugs.slugify
      #   kwds:
      #     case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde


# not_in_nav: |
#   /tutorials/**/*.md

# TODO:: edit all files title to not have bold stuff
nav:
  - Home: index.md
  - Fundamental Dives:
    - Fundamental Concepts:
      - Concurrency and Parallelism: fundamentaldives/FundamentalConcepts/ConcurrencyParallelism.md
    - Fundamental Principles:
      - SOLID: fundamentaldives/FundamentalPrinciples/SOLID.md
      - KISS: fundamentaldives/FundamentalPrinciples/KISS.md
      - DRY: fundamentaldives/FundamentalPrinciples/DRY.md
      - YAGNI: fundamentaldives/FundamentalPrinciples/YAGNI.md
    - Design Patterns:
      - Singleton: fundamentaldives/DesignPatterns/Singleton.md
      - Factory Method: fundamentaldives/DesignPatterns/FactoryMethod.md # TODO:: rename the file and title
      - Abstract Factory: fundamentaldives/DesignPatterns/AbstractFactory.md
      - Builder: fundamentaldives/DesignPatterns/Builder.md
      - Prototype: fundamentaldives/DesignPatterns/Prototype.md
      - Adapter: fundamentaldives/DesignPatterns/Adapter.md
      - Bridge: fundamentaldives/DesignPatterns/Bridge.md
      - Composite: fundamentaldives/DesignPatterns/Composite.md
      - Decorater: fundamentaldives/DesignPatterns/Decorator.md
      - Facade: fundamentaldives/DesignPatterns/Facade.md
      - Iterator: fundamentaldives/DesignPatterns/Iterator.md
      - Strategy: fundamentaldives/DesignPatterns/Strategy.md
      - Circuit Breakers: fundamentaldives/DesignPatterns/CircuitBreakers.md
  - Language Dives:
      - Java:
        - JDK, JRE, JVM: langdives/Java/JDK-JRE-JVM.md
        - Maven: langdives/Java/Maven.md 
        - Gradle: langdives/Java/Gradle.md
        - Maven vs Gradle: langdives/Java/MavenVsGradle.md
        - Memory Model: langdives/Java/MemoryModel.md
        - 4 Pillars: langdives/Java/4Pillars.md
        - Access modifiers: langdives/Java/AccessModifPPPPP.md
        - Keywords/Terminologies: langdives/Java/KeyWordsTerminolgies.md
        - Primitives & References: langdives/Java/PrimitiveReferenceTypes.md
        - Reference Types Indepth: langdives/Java/ReferenceTypesInDepth.md
        - Pass By Value: langdives/Java/JavaPassBy.md # TODO:: need to edit this title
        - Collections JCF: langdives/Java/Collections-JCF.md
        - Streams and Lambas: langdives/Java/StreamsLambdas.md
        - Threads: langdives/Java/Threads.md
        - Threads - Atomicity: langdives/Java/Threads-Atomicity.md
        - Thread Pools: langdives/Java/ThreadPools.md
        - Thread Pool Tuning: langdives/Java/ThreadPoolTuning.md
        - Intrinsic Locking: langdives/Java/Locking-Intrinsic.md
        - Reentrant Locking: langdives/Java/Locking-Reentrant.md
        - Intrinsic vs Reentrant Locking: langdives/Java/LockingIntrinsicReentrant.md
        - ReentrantRW Locking: langdives/Java/Locking-ReentrantReadWrite.md
        - DeadLock: langdives/Java/Locking-Issues-DeadLock.md
        - LiveLock: langdives/Java/Locking-Issues-LiveLock.md
        - Starvation: langdives/Java/Locking-Issues-Starvation.md
        - Other Locking issues: langdives/Java/Locking-Issues-Others.md
        - Garbage Collection(rs): langdives/Java/GarbageCollection.md
        - Java 8 vs 11 vs 17 vs 21: langdives/Java/Java8vs11vs17vs21.md
      - Spring: 
        - langdives/Java/Spring/index.md
        - Spring Core Framework: langdives/Java/Spring/SpringCoreFramework.md
        - Spring Boot: langdives/Java/Spring/SpringBoot.md
        - Spring Boot Annotations: langdives/Java/Spring/SpringAnnotations.md
        - Spring Framework vs Boot: langdives/Java/Spring/SpringFrameworkVsSpringBoot.md
  - Tech Dives: 
    - General Concepts:
      - Git: techdives/GeneralConcepts/git.md
    - Distributed Concepts:
      - High Availability and Fault Tolerance: techdives/DistrubutedConcepts/HighAvailabilityFaultTolerance.md
    - Distributed Systems:
      - Docker & K8s : techdives/DistrubutedSystems/DockerAndK8s.md # need to edit this title
      - Simple Storage Service - S3: techdives/DistrubutedSystems/S3.md
      - Kafka: techdives/DistrubutedSystems/Kafka.md
      - Elasticsearch: techdives/DistrubutedSystems/ElasticSearch.md
      - Redis: techdives/DistrubutedSystems/Redis.md
      - Cassandra: techdives/DistrubutedSystems/Cassandra.md
  - Blog:
    - blog/index.md
  - Change Log: changelog/index.md