summaryrefslogtreecommitdiff
path: root/mkdocs.yml
blob: 45144ae1ac009de3aded50539e61ee7266fe922b (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
site_name: 'Binary Ninja User Documentation'
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:
        scheme: binja
        accent: red
    features:
        - navigation.tracking
        - navigation.tabs
        - navigation.tabs.sticky
        - navigation.sections
        - navigation.expand
        - navigation.prune
        - navigation.indexes
        - navigation.top
    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
    - offline

markdown_extensions:
    - codehilite
    - admonition
    - pymdownx.details
    - pymdownx.superfences
    - toc:
        permalink: True

nav:
    - Home: 'index.md'
    - Getting Started: 'getting-started.md'
        #
        #- User Manual: 'guide/'
        #- Developer Guide: 'dev/'
        #- About: 'about/'
    - User Manual:
        - 'guide/index.md'
        - Plugins: 'guide/plugins.md'
        - Settings: 'guide/settings.md'
        - Types: 'guide/type.md'
        - C++ Types: 'guide/cpp.md'
        - Debug Info: 'guide/debuginfo.md'
        - Debugger: 'guide/debugger.md'
        - Objective-C (Experimental): 'guide/objectivec.md'
        - Troubleshooting: 'guide/troubleshooting.md'
    - Developer Guide:
        - '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'
          - Flag Guide: 'dev/flags.md'
        - Important Concepts:
          - 'dev/concepts.md'
          - Applying Annotations: 'dev/annotation.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'

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