-
Notifications
You must be signed in to change notification settings - Fork 561
/
mkdocs.yml
130 lines (124 loc) · 3.42 KB
/
mkdocs.yml
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
# Project information
site_name: BBOT Docs
site_url: https://blacklanternsecurity.github.io/bbot/
site_author: TheTechromancer
site_description: >-
OSINT automation for hackers
# Repository
repo_name: blacklanternsecurity/bbot
repo_url: https://github.com/blacklanternsecurity/bbot
watch:
- "mkdocs.yml"
- "bbot"
- "docs"
# Page tree
nav:
- User Manual:
- Basics:
- Getting Started: index.md
- How it Works: how_it_works.md
- Comparison to Other Tools: comparison.md
- Scanning:
- Scanning Overview: scanning/index.md
- Presets:
- Overview: scanning/presets.md
- List of Presets: scanning/presets_list.md
- Events: scanning/events.md
- Output: scanning/output.md
- Tips and Tricks: scanning/tips_and_tricks.md
- Advanced Usage: scanning/advanced.md
- Configuration: scanning/configuration.md
- Modules:
- List of Modules: modules/list_of_modules.md
- Nuclei: modules/nuclei.md
- Custom YARA Rules: modules/custom_yara_rules.md
- Misc:
- Contribution: contribution.md
- Release History: release_history.md
- Troubleshooting: troubleshooting.md
- Developer Manual:
- Development Overview: dev/index.md
- Setting Up a Dev Environment: dev/dev_environment.md
- BBOT Internal Architecture: dev/architecture.md
- How to Write a BBOT Module: dev/module_howto.md
- Unit Tests: dev/tests.md
- Discord Bot Example: dev/discord_bot.md
- Code Reference:
- Scanner: dev/scanner.md
- Presets: dev/presets.md
- Event: dev/event.md
- Target: dev/target.md
- BaseModule: dev/basemodule.md
- BBOTCore: dev/core.md
- Engine: dev/engine.md
- Helpers:
- Overview: dev/helpers/index.md
- Command: dev/helpers/command.md
- DNS: dev/helpers/dns.md
- Interactsh: dev/helpers/interactsh.md
- Miscellaneous: dev/helpers/misc.md
- Web: dev/helpers/web.md
- Word Cloud: dev/helpers/wordcloud.md
theme:
name: material
logo: bbot.png
favicon: favicon.png
features:
- content.code.copy
- content.tooltips
- navigation.tabs
- navigation.sections
- navigation.expand
- toc.integrate
palette:
- scheme: slate
primary: black
accent: deep orange
plugins:
- mike
- search
- extra-sass
- mkdocstrings:
enable_inventory: true
handlers:
python:
options:
heading_level: 1
show_signature_annotations: true
show_root_toc_entry: false
show_root_heading: true
show_root_full_path: false
separate_signature: true
docstring_section_style: "list"
filters:
- "!^_"
- "^__init__$"
import:
- https://docs.python.org/3.11/objects.inv
- https://omegaconf.readthedocs.io/en/latest/objects.inv
extra:
version:
provider: mike
default: Stable
markdown_extensions:
- tables
- attr_list
- admonition
- pymdownx.details
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.highlight:
use_pygments: True
noclasses: True
pygments_style: github-dark
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
extra_javascript:
- javascripts/tablesort.js
- javascripts/tablesort.min.js
- javascripts/vega@5.js
- javascripts/vega-lite@5.js
- javascripts/vega-embed@6.js