From b1900d6ebcc39738885f90fa9f18b28206a74947 Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Sun, 24 Jul 2016 19:13:40 -0400 Subject: very early checkin of template for user-docs, only a few pages filled out --- mkdocs.yml | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 mkdocs.yml (limited to 'mkdocs.yml') diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..556e722d --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,41 @@ +site_name: 'Binary Ninja Documentation' +site_url: 'https://docs.binary.ninja/' +repo_url: 'https://github.com/vector35/binaryninja-api/' +repo_name: 'github' +site_description: 'Documentation for the Binary Ninja reverse engineering platform' +site_author: 'Vector 35 LLC' +site_favicon: 'favicon.ico' +google_analytics: ['UA-72420552-3', 'docs.binary.ninja' ] + +theme_dir: 'mkdocs-material/material' +theme: 'material' +copyright: '(cc) Vector 35 LLC' + +markdown_extensions: + - codehilite + - admonition + - toc: + permalink: True + +pages: + - Home: 'index.md' + - Getting Started: 'getting-started.md' + - User Guide: + - Installing: 'guide/installing.md' + - Running: 'guide/running.md' + - Interface: 'guide/interface.md' + - Types Library: 'guide/type.md' + - Using Plugins: 'guide/plugins.md' + - Troubleshooting: 'guide/troubleshooting.md' + - Developer Guide: + - Plugin Design: 'dev/plugins.md' + - API: 'dev/api.md' + - About: + - License: 'about/license.md' + - Open Source: 'about/open-source.md' + +extra: + author: + github: 'Vector35' + twitter: 'vector_35' + logo: 'images/logo.png' -- cgit v1.3.1