From 69f9dc441a0faeb056a0f83286da143437eefefa Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Thu, 19 May 2022 21:28:28 -0400 Subject: change mkdocs config names, reorder ToC and other cleanup --- mkdocs-stable.yml | 65 ------------------------------------------------------- mkdocs-verify.yml | 58 +++++++++++++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 21 ++++++++---------- 3 files changed, 67 insertions(+), 77 deletions(-) delete mode 100644 mkdocs-stable.yml create mode 100644 mkdocs-verify.yml diff --git a/mkdocs-stable.yml b/mkdocs-stable.yml deleted file mode 100644 index 59445176..00000000 --- a/mkdocs-stable.yml +++ /dev/null @@ -1,65 +0,0 @@ -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_css: [ 'docs.css?1585271138', 'lightslider.min.css?1585271138'] -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: '(cc) Vector 35 Inc' - -plugins: - - search - - htmlproofer - -use_directory_urls: False - -markdown_extensions: - - codehilite - - admonition - - toc: - permalink: True - -nav: - - Home: 'index.md' - - Getting Started Guide: 'getting-started.md' - - User Guide: - #- Installing: 'guide/installing.md' - #- Running: 'guide/running.md' - #- Interface: 'guide/interface.md' - #- Patching: 'guide/patching.md' - #- SCC: 'guide/scc.md' - - Using Plugins: 'guide/plugins.md' - - Troubleshooting: 'guide/troubleshooting.md' - - Working with Types: 'guide/type.md' - - Using Debugger (Beta): 'guide/debugger.md' - - Developer Guide: - - Using the API: 'dev/api.md' - - Writing Python Plugins: 'dev/plugins.md' - - Batch / Headless 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' - - 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' 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: '(cc) Vector 35 Inc' + +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: Overview: 'dev/bnil-overview.md' + - BNIL Guide: LLIL: 'dev/bnil-llil.md' + - BNIL Guide: 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' diff --git a/mkdocs.yml b/mkdocs.yml index 17c97d08..2ca95b7a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,9 +4,9 @@ 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_css: [ 'docs.css?1585271138', 'lightslider.min.css?1585271138'] extra_javascript: ['lightslider.min.js?1585271138', 'highlight.min.js', 'cpp.min.js', 'python.min.js'] theme: name: readthedocs @@ -20,6 +20,9 @@ theme: copyright: '(cc) Vector 35 Inc' +plugins: + - search + markdown_extensions: - codehilite - admonition @@ -30,24 +33,18 @@ nav: - Home: 'index.md' - Getting Started Guide: 'getting-started.md' - User Guide: - #- Installing: 'guide/installing.md' - #- Running: 'guide/running.md' - #- Interface: 'guide/interface.md' - #- Patching: 'guide/patching.md' - #- SCC: 'guide/scc.md' - - Using Plugins: 'guide/plugins.md' + - Plugins: 'guide/plugins.md' + - Types: 'guide/type.md' + - Debugger (Beta): 'guide/debugger.md' - Troubleshooting: 'guide/troubleshooting.md' - - Working with Types: 'guide/type.md' - - Using Debugger (Beta): 'guide/debugger.md' - Developer Guide: - - Using the API: 'dev/api.md' - - Writing Python Plugins: 'dev/plugins.md' + - API: 'dev/api.md' + - Python Plugins: 'dev/plugins.md' - Batch / Headless 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' - - Working with Workflows: 'dev/workflows.md' - Creating Themes: 'dev/themes.md' - Contributing Documentation: 'dev/documentation.md' - About: -- cgit v1.3.1