mkdocs.yml

# MkDocs Configuration for NeetCode Practice Framework
site_name: NeetCode Practice Framework
site_description: A high-performance Python LeetCode / algorithm practice framework
site_url: https://lufftw.github.io/neetcode/
repo_url: https://github.com/lufftw/neetcode
repo_name: neetcode

# Exclude files from build
exclude_docs: |
  mindmaps/README.md
  in-progress/**

# Theme
theme:
  name: material
  language: en
  custom_dir: docs/_mkdocs/overrides
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  
  icon:
    repo: fontawesome/brands/github
  
  font:
    text: Inter
    code: JetBrains Mono

# Extensions
markdown_extensions:
  - md_in_html
  - toc:
      permalink: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
  - pymdownx.mark
  - pymdownx.smartsymbols
  - 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

# Plugins
plugins:
  - search:
      lang: en
  - include-markdown
  - minify:
      minify_html: true
  - git-revision-date-localized:
      type: datetime                  # Show full datetime, e.g. "December 20, 2025 14:30"
      locale: en                      # English locale
      timezone: Asia/Taipei           # Set timezone to Taipei (avoid UTC offset)
      enable_creation_date: true      # Also show "creation date" (first commit)
      fallback_to_build_date: true    # Use build date if Git history is unavailable (for some CI environments)
  - document-dates:
      position: top            # Display position: top(after title) bottom(end of document), default: top
      type: date               # Date type: date datetime timeago, default: date
      exclude:                 # List of excluded files
        - temp.md                  # Example: exclude the specified file
        - blog/*                   # Example: exclude all files in blog folder, including subfolders
      date_format: '%Y-%m-%d'  # Date format strings (e.g., %Y-%m-%d, %b %d, %Y)
      time_format: '%H:%M:%S'  # Time format strings (valid only if type=datetime)
      show_created: true       # Show creation date: true false, default: true
      show_updated: true       # Show last updated date: true false, default: true
      show_author: true        # Show author: true(avatar) text(text) false(hidden), default: true
      locale: en               # Language: en
  - mindmaps-lastmod
  - privacy:
      links: true
      links_attr_map:
        target: _blank
      links_noopener: true

# Navigation
nav:
  - 🏠 Home:
    - index.md
    - 繁體中文: index_zh-TW.md
  - 📐 Patterns:
    - Overview: patterns/README.md
    - Sliding Window:
      - Intuition: patterns/sliding_window/intuition.md
      - Templates: patterns/sliding_window/templates.md
    - Two Pointers:
      - Intuition: patterns/two_pointers/intuition.md
      - Templates: patterns/two_pointers/templates.md
    - Binary Search:
      - Intuition: patterns/binary_search/intuition.md
      - Templates: patterns/binary_search/templates.md
    - Monotonic Stack:
      - Intuition: patterns/monotonic_stack/intuition.md
      - Templates: patterns/monotonic_stack/templates.md
    - Backtracking Exploration:
      - Intuition: patterns/backtracking_exploration/intuition.md
      - Templates: patterns/backtracking_exploration/templates.md
    - Prefix Sum:
      - Intuition: patterns/prefix_sum/intuition.md
      - Templates: patterns/prefix_sum/templates.md
    - Heap / Priority Queue:
      - Intuition: patterns/heap/intuition.md
      - Templates: patterns/heap/templates.md
    - Graph Traversal (DFS/BFS):
      - Intuition: patterns/graph/intuition.md
      - Templates: patterns/graph/templates.md
    - Interval:
      - Intuition: patterns/interval/intuition.md
      - Templates: patterns/interval/templates.md
    - Union-Find:
      - Intuition: patterns/union_find/intuition.md
      - Templates: patterns/union_find/templates.md
    - Tree Traversal:
      - Intuition: patterns/tree/intuition.md
      - Templates: patterns/tree/templates.md
    - Topological Sort:
      - Intuition: patterns/topological_sort/intuition.md
      - Templates: patterns/topological_sort/templates.md
    - Shortest Path:
      - Intuition: patterns/shortest_path/intuition.md
      - Templates: patterns/shortest_path/templates.md
    - Trie:
      - Intuition: patterns/trie/intuition.md
      - Templates: patterns/trie/templates.md
    - Greedy Core:
      - Intuition: patterns/greedy_core/intuition.md
      - Templates: patterns/greedy_core/templates.md
    - DP 1D Linear:
      - Intuition: patterns/dp_1d_linear/intuition.md
      - Templates: patterns/dp_1d_linear/templates.md
    - DP Knapsack/Subset:
      - Intuition: patterns/dp_knapsack_subset/intuition.md
      - Templates: patterns/dp_knapsack_subset/templates.md
    - Math/Number Theory:
      - Intuition: patterns/math_number_theory/intuition.md
      - Templates: patterns/math_number_theory/templates.md
    - Segment Tree/Fenwick Tree:
      - Intuition: patterns/segment_tree_fenwick/intuition.md
      - Templates: patterns/segment_tree_fenwick/templates.md
    - Line Sweep:
      - Intuition: patterns/line_sweep/intuition.md
      - Templates: patterns/line_sweep/templates.md
    - Tree DP:
      - Intuition: patterns/tree_dp/intuition.md
      - Templates: patterns/tree_dp/templates.md
    - Bitmask DP:
      - Intuition: patterns/bitmask_dp/intuition.md
      - Templates: patterns/bitmask_dp/templates.md
    - String DP:
      - Intuition: patterns/string_dp/intuition.md
      - Templates: patterns/string_dp/templates.md
    - Monotonic Deque:
      - Intuition: patterns/monotonic_deque/intuition.md
      - Templates: patterns/monotonic_deque/templates.md
    - Interval DP:
      - Intuition: patterns/interval_dp/intuition.md
      - Templates: patterns/interval_dp/templates.md
    - String Matching:
      - Intuition: patterns/string_matching/intuition.md
      - Templates: patterns/string_matching/templates.md
    - Game Theory DP:
      - Intuition: patterns/game_theory_dp/intuition.md
      - Templates: patterns/game_theory_dp/templates.md
    - Multi-Source BFS:
      - Intuition: patterns/grid_bfs_multi_source/intuition.md
      - Templates: patterns/grid_bfs_multi_source/templates.md
    - K-Way Merge:
      - Intuition: patterns/k_way_merge/intuition.md
      - Templates: patterns/k_way_merge/templates.md
    - Linked List Reversal:
      - Intuition: patterns/linked_list_in_place_reversal/intuition.md
      - Templates: patterns/linked_list_in_place_reversal/templates.md
  - 🧠 Mind Maps:
    - Overview: mindmaps/index.md
    - AI Analysis (English): mindmaps/neetcode-ontology-ai-en.md
    - AI Analysis (繁體中文): mindmaps/neetcode-ontology-ai-zh-tw.md
    - Agent Evolved (English): mindmaps/neetcode-ontology-agent-evolved-en.md
    - Agent Evolved (繁體中文): mindmaps/neetcode-ontology-agent-evolved-zh-tw.md
    - Pattern Hierarchy: mindmaps/pattern-hierarchy.md
    - Family Derivation: mindmaps/family-derivation.md
    - Algorithm Usage: mindmaps/algorithm-usage.md
    - Data Structure: mindmaps/data-structure.md
    - Company Coverage: mindmaps/company-coverage.md
    - Learning Roadmaps: mindmaps/roadmap-paths.md
    - Problem Relations: mindmaps/problem-relations.md
    - Solution Variants: mindmaps/solution-variants.md
    - Difficulty × Topics: mindmaps/difficulty-topics.md
  - 🔧 Guides:
    - Virtual Environment Setup: contributors/virtual-env-setup.md
    - VSCode Setup: contributors/vscode-setup.md
    - Create New Problem: guides/new-problem.md
    - Create Practice File: guides/new-practice.md
    - Create New Pattern: guides/new-pattern.md
  - 📚 Reference:
    - Solution Contract: contracts/solution-contract.md
    - Generator Contract: contracts/generator-contract.md
    - Test File Format: contracts/test-file-format.md
    - Codec Contract: contracts/codec.md
    - Problem Support Boundary: contracts/problem-support-boundary.md
    - Documentation Header Spec: contracts/documentation-header-spec.md
    - Ontology Design: reference/ontology-design.md
  - 🏗️ Architecture:
    - Overview: architecture/README.md
    - Packages Overview: architecture/packages-overview.md
    - Architecture Migration: architecture/architecture-migration.md
  - 📦 Packages:
    - Runner:
      - Overview: runner/README.md
      - CLI Output Contract: runner/cli-output-contract.md
      - Profiling:
        - Input Scale Metrics: runner/profiling/input-scale-metrics.md
        - CLI Output (Memory): runner/profiling/cli-output-memory.md
      - Benchmarking:
        - Memory Metrics: runner/benchmarking/memory-metrics.md
    - CodeGen: packages/codegen/README.md
    - LeetCode DataSource: packages/leetcode_datasource/README.md
    - Practice Workspace: packages/practice_workspace/README.md
  - 🛠️ Tools:
    - Overview: tools/README.md
    - LeetCode API: tools/leetcode-api/README.md
    - Docstring Formatter: tools/docstring/README.md
    - Maintenance Tools: tools/maintenance/README.md
    - Mind Maps:
      - Generator: tools/mindmaps/README.md
      - AI Markmap Agent: tools/mindmaps/ai-markmap-agent/README.md
    - Pattern Docs Generator: tools/patterndocs/README.md
    - Review Code: tools/review-code/README.md
  - 👥 Contributors:
    - Overview: contributors/README.md
    - Testing Documentation: contributors/testing.md
    - Documentation Architecture: contributors/documentation-architecture.md
    - Documentation Naming: contributors/documentation-naming.md
    - Package Documentation Strategy: contributors/package-documentation-strategy.md
    - Docs Directory Organization: contributors/docs-directory-organization.md

# Extra
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/lufftw/neetcode
      canonical_url: https://lufftw.github.io/neetcode/
  generator: false

extra_css:
  - _mkdocs/stylesheets/extra.css
  - assets/document_dates/user.config.css

extra_javascript:
  - https://cdn.jsdelivr.net/npm/d3@7
  - https://cdn.jsdelivr.net/npm/markmap-view
  - https://cdn.jsdelivr.net/npm/markmap-lib
  - https://cdn.jsdelivr.net/npm/markmap-toolbar
  - assets/document_dates/user.config.js