summaryrefslogtreecommitdiff
path: root/mkdocs-verify.yml
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2022-05-19 21:28:28 -0400
committerJordan Wiens <jordan@psifertex.com>2022-05-19 21:29:09 -0400
commit69f9dc441a0faeb056a0f83286da143437eefefa (patch)
treece09ecf1d6e023600daa30ae68634520cc649935 /mkdocs-verify.yml
parentbffa656ee3da2093d759615253a50a955b6e4da8 (diff)
change mkdocs config names, reorder ToC and other cleanup
Diffstat (limited to 'mkdocs-verify.yml')
-rw-r--r--mkdocs-verify.yml58
1 files changed, 58 insertions, 0 deletions
diff --git a/mkdocs-verify.yml b/mkdocs-verify.yml
new file mode 100644
index 00000000..e2fedbd4
--- /dev/null
+++ b/mkdocs-verify.yml
@@ -0,0 +1,58 @@
+site_name: 'Binary Ninja User Documentation'
+site_url: 'https://docs.binary.ninja/'
+repo_url: 'https://binary.ninja/'
+repo_name: 'github'
+site_description: 'Documentation for the Binary Ninja reverse engineering platform'
+site_author: 'Vector 35 Inc'
+google_analytics: ['UA-72420552-3', 'docs.binary.ninja' ]
+use_directory_urls: False
+extra_css: [ 'docs.css?1585271138', 'lightslider.min.css?1585271138', 'github.min.css' ]
+extra_javascript: ['lightslider.min.js?1585271138', 'highlight.min.js', 'cpp.min.js', 'python.min.js']
+theme:
+ name: readthedocs
+ favicon: 'img/favicon.ico'
+ highlightjs: false
+ 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
+ - htmlproofer:
+ raise_error: True
+
+markdown_extensions:
+ - codehilite
+ - admonition
+ - toc:
+ permalink: True
+
+nav:
+ - Home: 'index.md'
+ - Getting Started Guide: 'getting-started.md'
+ - User Guide:
+ - Plugins: 'guide/plugins.md'
+ - Types: 'guide/type.md'
+ - Debugger (Beta): 'guide/debugger.md'
+ - Troubleshooting: 'guide/troubleshooting.md'
+ - Developer Guide:
+ - API: 'dev/api.md'
+ - Python Plugins: 'dev/plugins.md'
+ - Batch / Headless Automation: 'dev/batch.md'
+ - 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'
+ - Creating Themes: 'dev/themes.md'
+ - Contributing Documentation: 'dev/documentation.md'
+ - About:
+ - License: 'about/license.md'
+ - Open Source: 'about/open-source.md'
+
+extra:
+ disablesearch: True
+ logo: 'images/logo.png'