From ed6e4dd83fb600a5391c2ed9280417ecd149ed34 Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Tue, 28 Sep 2021 11:51:21 -0400 Subject: adding stable docs config for online upload, and removing analytics from offline docs --- mkdocs-stable.yml | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 1 - 2 files changed, 64 insertions(+), 1 deletion(-) create mode 100644 mkdocs-stable.yml diff --git a/mkdocs-stable.yml b/mkdocs-stable.yml new file mode 100644 index 00000000..3a5196e2 --- /dev/null +++ b/mkdocs-stable.yml @@ -0,0 +1,64 @@ +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' + - 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.yml b/mkdocs.yml index 705e588a..e41da975 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,7 +4,6 @@ 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'] -- cgit v1.3.1