mcp-windbg/mkdocs.yml at develop · svnscha/mcp-windbg · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
site_name: MCP Server for WinDbg
site_description: >-
  User guide for mcp-windbg - a Model Context Protocol server that lets AI models
  analyze Windows crash dumps and drive live or remote debugging through WinDbg/CDB.
  Configure your MCP client, analyze dumps, and debug remote targets in natural language.
site_author: Sven Scharmentke
site_url: https://svnscha.github.io/mcp-windbg/
repo_url: https://github.com/svnscha/mcp-windbg
repo_name: svnscha/mcp-windbg
copyright: Copyright &copy; svnscha - MIT License

docs_dir: docs

extra_css:
  - assets/extra.css

extra_javascript:
  - assets/mermaid.js

validation:
  links:
    anchors: warn

theme:
  name: material
  language: en
  icon:
    repo: fontawesome/brands/github
  palette:
    # Light is the default (listed first, no media query). The toggle is remembered.
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - toc.follow
    - content.code.copy
    - search.suggest
    - search.highlight

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.keys
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid-diagram
          format: !!python/name:pymdownx.superfences.fence_code_format

nav:
  - Home: index.md
  - Getting started: getting-started.md
  - Use cases:
      - Overview: scenarios/index.md
      - Analyze a crash dump: scenarios/crash-dump.md
      - Debug a remote target: scenarios/remote-debugging.md
      - Debug a kernel target: scenarios/kernel-debugging.md
      - Triage multiple dumps: scenarios/triage.md
      - Debug from another machine: scenarios/http-service.md
      - Redact sensitive data: scenarios/redaction.md
  - Reference:
      - Overview: reference/index.md
      - Command-line options: reference/cli.md
      - Tools: reference/tools.md
      - Prompts: reference/prompts.md
      - Claude Code plugin: reference/plugin.md
      - Client configuration: reference/clients.md
  - Troubleshooting: troubleshooting.md
  - Development: development.md

plugins:
  - search