ntcompress/mkdocs.yml at main · StrongWind1/ntcompress · 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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
site_name: ntcompress
site_description: Pure-Python implementations of every Microsoft ESE record-compression format and Windows ntdll compression format.
site_url: https://strongwind.dev/ntcompress/
repo_url: https://github.com/StrongWind1/ntcompress
repo_name: StrongWind1/ntcompress
edit_uri: edit/main/docs/
copyright: Copyright &copy; 2025 - 2026 StrongWind1

theme:
  name: material
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
  palette:
    # Dark mode (default) — respects system preference
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to light mode
    # Light mode — respects system preference
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
  features:
    # Navigation
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tracking
    - navigation.sections
    - navigation.path
    - navigation.top
    - navigation.indexes
    - navigation.footer
    # Table of contents
    - toc.follow
    # Search
    - search.highlight
    - search.suggest
    - search.share
    # Header
    - header.autohide
    - announce.dismiss
    # Content
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - content.action.view

plugins:
  - search
  # Downloads the Google Fonts requested by theme.font at build time so the
  # published site makes no third-party requests.
  - privacy
  # Project-specific: the API reference pages are generated from docstrings.
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: false
            show_root_heading: true
            show_root_full_path: true
            members_order: source
            docstring_style: google
            merge_init_into_class: true
            show_signature_annotations: true

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

nav:
  - Home: index.md
  - Getting started: getting-started.md
  - User guide:
      - ESE compression: user-guide/ese.md
      - ntdll compression: user-guide/ntdll.md
      - Error handling: user-guide/errors.md
  - Reference:
      - API reference:
          - reference/api/index.md
          - ntcompress.ese: reference/api/ese.md
          - ESE checksums: reference/api/ese-checksums.md
          - ESE format modules: reference/api/ese-formats.md
          - ntcompress.ntdll: reference/api/ntdll.md
          - ntdll format modules: reference/api/ntdll-formats.md
          - Exceptions: reference/api/exceptions.md
      - Format details: reference/formats.md
      - Spec traceability: reference/spec-traceability.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/StrongWind1/ntcompress
      name: ntcompress on GitHub
  generator: false

extra_css:
  # theme.css is the site palette; primary and accent are both `custom`,
  # so every Material colour variable is defined there.
  - stylesheets/theme.css

strict: true

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn