mkdocs.yml

site_name: TilekarOS Documentation
site_description: A 32-bit x86 Hobby Operating System
site_author: TilekarOS Team
repo_name: SohamTilekar/TilekarOS
repo_url: https://github.com/SohamTilekar/TilekarOS
edit_uri: edit/main/docs/

copyright: Copyright © 2024 - 2026 Soham Tilekar Under MIT License

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    annotation: material/more
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.footer
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.instant.preview
    - navigation.path
    - navigation.prune
    - navigation.tracking
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - content.action.edit
    - content.action.view
    - toc.follow
    - header.autohide

plugins:
  - search

markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: .
      check_paths: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.caret
  - attr_list
  - md_in_html
  - abbr
  - def_list
  - footnotes

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/SohamTilekar/TilekarOS
    - icon: fontawesome/solid/paper-plane
      link: mailto:sohamtilekar233@gmail.com

extra_javascript:
  - javascripts/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra_css:
  - https://unpkg.com/katex@0/dist/katex.min.css

nav:
  - 🏠 Home: README.md
  - 🛠️ Getting Started:
      - 🏗️ Build System: getting-started/build-system.md
      - 📥 Installation Guide: getting-started/installation.md
      - 📂 Project Structure: getting-started/project-structure.md
      - 🧪 Experimenting & Messing Around: getting-started/experimenting.md
  - 🧠 Kernel Internals:
      - 🚀 Boot & Initialization: kernel/boot-and-init.md
      - 📟 CPU & Interrupts: kernel/cpu-internals.md
      - 💾 Memory Management: kernel/memory-management.md
      - 🔄 Multitasking & ELF: kernel/multitasking.md
      - 📁 Filesystem Stack: kernel/filesystem.md
  - 🔌 Drivers & Hardware:
      - 📟 Driver Reference: drivers/driver-reference.md
  - 📚 API Reference:
      - 🔌 System Call Reference: api/syscall-reference.md
      - 📚 LibC Reference: api/libc-reference.md
      - ⚙️ LibC Internals: api/libc-internals.md
  - 👷 Development & Contributions:
      - 📏 Coding Style: development/coding-style.md
      - 📖 Documentation Guide: development/documentation-guide.md