diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2022-10-17 06:23:08 -0400 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2022-10-17 06:23:08 -0400 |
| commit | 4942700ca3387b64cc6443a80bac60b470588bb9 (patch) | |
| tree | 7ab0b29c72e9146734b3cb24d062dff148c2b8ec /mkdocs.yml | |
| parent | fba5ef5a7cb2c0f76cf2531adddda9d3023c2357 (diff) | |
documentation overhaul
Diffstat (limited to 'mkdocs.yml')
| -rw-r--r-- | mkdocs.yml | 39 |
1 files changed, 31 insertions, 8 deletions
@@ -1,7 +1,7 @@ site_name: 'Binary Ninja User Documentation' site_url: 'https://docs.binary.ninja/' repo_url: 'https://binary.ninja/' -repo_name: 'github' +repo_name: 'binary.ninja' site_description: 'Documentation for the Binary Ninja reverse engineering platform' site_author: 'Vector 35 Inc' google_analytics: ['UA-72420552-3', 'docs.binary.ninja' ] @@ -9,9 +9,20 @@ 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: readthedocs + name: material favicon: 'img/favicon.ico' highlightjs: false + palette: + scheme: binja + accent: red + features: + - navigation.tracking + - navigation.tabs + - navigation.sections + - navigation.expand + - navigation.prune + - navigation.indexes + - navigation.top shortcuts: help: 191 # ? next: 78 # n @@ -26,29 +37,41 @@ plugins: markdown_extensions: - codehilite - admonition + - pymdownx.details + - pymdownx.superfences - toc: permalink: True nav: - - Home: 'index.md' - - Getting Started Guide: 'getting-started.md' - - User Guide: + - Home: '/' + - 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' - Debugger: 'guide/debugger.md' - Objective-C (Beta): 'guide/objectivec.md' - Troubleshooting: 'guide/troubleshooting.md' - Developer Guide: - - API: 'dev/api.md' - - Python Plugins: 'dev/plugins.md' - - Batch / Headless Automation: 'dev/batch.md' + - 'dev/index.md' + - Important Concepts: 'dev/concepts.md' + - Cookbook: 'dev/cookbook.md' + - Writing Plugins: 'dev/plugins.md' + - Automation: 'dev/batch.md' - BNIL Guide: Overview: 'dev/bnil-overview.md' - BNIL Guide: LLIL: 'dev/bnil-llil.md' - BNIL Guide: MLIL: 'dev/bnil-mlil.md' - Flag Guide: 'dev/flags.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' |