summaryrefslogtreecommitdiff
path: root/mkdocs.yml
blob: a728e4a6c5cfc541871afb864ec23da5ba6c6a91 (plain)
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
141
142
143
144
145
146
147
site_name: 'Binary Ninja User Documentation'
dev_addr: 0.0.0.0:8000
site_url: 'https://docs.binary.ninja/'
repo_url: 'https://binary.ninja/'
repo_name: 'binary.ninja'
site_description: 'Documentation for the Binary Ninja reverse engineering platform'
site_author: 'Vector 35 Inc'
use_directory_urls: false
extra_css: ['docs.css', 'github.min.css', 'juxtapose.min.css']
extra_javascript: ['highlight.min.js', 'cpp.min.js', 'python.min.js', 'juxtapose.min.js']
theme:
    name: material
    custom_dir: overrides
    favicon: 'img/favicon.ico'
    font: false
    highlightjs: false
    palette:

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: binja
      accent: red
      primary: red
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: red
      accent: red
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    features:
        - navigation.tracking
        - navigation.tabs
        - navigation.tabs.sticky
        - navigation.expand
        - navigation.indexes # Consider revisiting this later if top-levels being clickable isn't obvious
        - navigation.top
        - content.code.copy
        - search.highlight
        - toc.follow

    shortcuts:
        help: 191    # ?
        next: 78     # n
        previous: 80 # p
        search: 191   # ? / /

        copyright: '(<a href="https://creativecommons.org/licenses/by/3.0/">cc</a>) <a href="https://vector35.com/">Vector 35 Inc</a>'

plugins:
    - search:
        lang: en
        separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
    - offline
    - privacy
    - glightbox:
        background: none
        shadow: false
    - htmlproofer:
        enabled: !ENV [VALIDATE, False]
    - redirects:
        redirect_maps:
            'index.md': 'getting-started.md'
            'guide/debugger.md': 'guide/debugger/index.md'
            'guide/remote-debugging.md': 'guide/debugger/remote-debugging.md'
            'guide/dbgeng-ttd.md': 'guide/debugger/dbgeng-ttd.md'

markdown_extensions:
    - attr_list
    - md_in_html
    - codehilite
    - admonition
    - pymdownx.details
    - pymdownx.superfences
    - pymdownx.tabbed:
        alternate_style: true
    - toc:
        permalink: True

nav:
    - User Documentation:
        - Getting Started: 'getting-started.md'
        - User Guide:
          - 'guide/index.md'
          - Using Plugins: 'guide/plugins.md'
          - All Settings: 'guide/settings.md'
          - Projects: 'guide/projects.md'
          - Enterprise: 'guide/enterprise/index.md'
          - Troubleshooting: 'guide/troubleshooting.md'
          - Objective-C: 'guide/objectivec.md'
          - Firmware Ninja: 'guide/firmwareninja.md'
        - Debugger:
            - Overview: 'guide/debugger/index.md'
            - Remote Debugging: 'guide/debugger/remote-debugging.md'
            - Time Travel Debugging (Windows): 'guide/debugger/dbgeng-ttd.md'
            - Time Travel Debugging (Linux): 'guide/debugger/gdbrsp-ttd.md'
            - Kernel Debugging (Windows): 'guide/debugger/windows-kd.md'
            - Corellium Remote Debugging: 'guide/debugger/corellium-remote-debugging.md'
        - Migration Guide:
            - 'guide/migration/index.md'
            - Migrating from IDA: 'guide/migration/migrationguideida.md'
            - Migrating from Ghidra: 'guide/migration/migrationguideghidra.md'
        - Types:
            - 'guide/types/index.md'
            - Basic Types: 'guide/types/basictypes.md'
            - Working With Types: 'guide/types/type.md'
            - Type Attributes and Annotations: 'guide/types/attributes.md'
            - Importing/Exporting Types: 'guide/types/typeimportexport.md'
            - Type Archives: 'guide/types/typearchives.md'
            - Type Libraries: 'guide/types/typelibraries.md'
            - Debug Info: 'guide/types/debuginfo.md'
            - Platform Types: 'guide/types/platformtypes.md'
            - C++ Types: 'guide/types/cpp.md'
    - Developer Documentation:
        - 'dev/index.md'
        - Cookbook: 'dev/cookbook.md'
        - Writing Plugins: 'dev/plugins.md'
        - Automation: 'dev/batch.md'
        - BNIL / Architectures:
            - BNIL Guide&#58; Overview: 'dev/bnil-overview.md'
            - BNIL Guide&#58; LLIL: 'dev/bnil-llil.md'
            - BNIL Guide&#58; MLIL: 'dev/bnil-mlil.md'
            - BNIL Guide&#58; HLIL: 'dev/bnil-hlil.md'
            - Flag Guide: 'dev/flags.md'
        - Types:
            - Applying Annotations: 'dev/annotation.md'
            - Type Libraries: 'dev/typelibraries.md'
        - Important Concepts:
            - 'dev/concepts.md'
            - User Informed Data Flow: 'dev/uidf.md'
            - Workflows: 'dev/workflows.md'
        - Creating Themes: 'dev/themes.md'
        - Contributing Documentation: 'dev/documentation.md'
    - About:
        - 'about/index.md'
        - License: 'about/license.md'
        - Open Source: 'about/open-source.md'
        - Icons: 'about/icons.md'

extra:
    disablesearch: True
    logo: 'images/logo.png'