[DOCS] Add logo to docs (#115)

DataDog · Sep 21, 2023 · 9d85a41 · 9d85a41
1 parent e147b7e
commit 9d85a41
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,21 @@
 # KubeHound  <!-- omit in toc -->
-
+<p align="left">
+  <img src="./docs/logo.png" alt="KubeHound" width="200" />
+</p>
 A Kubernetes attack graph tool allowing automated calculation of attack paths between assets in a cluster
 
-- [Quick Links](#quick-links)
+## Quick Links <!-- omit in toc -->
+
++ For an overview of the application architecture see the [design canvas](./docs/application/Architecture.excalidraw)
++ To see the attacks covered see the [edge definitions](./docs/edges/)
++ To contribute a new attack to the project follow the [contribution guidelines](./CONTRIBUTING.md)
+
+## Sample Attack Path  <!-- omit in toc -->
+
+![Example Path](./docs/images/example-graph.png)
+
+## Contents  <!-- omit in toc -->
+
 - [Requirements](#requirements)
   - [Application](#application)
   - [Test (Development only)](#test-development-only)
@@ -24,14 +37,6 @@ A Kubernetes attack graph tool allowing automated calculation of attack paths be
     - [CI Testing](#ci-testing)
 - [Acknowledgements](#acknowledgements)
 
-![Example Path](./docs/images/example-graph.png)
-
-## Quick Links
-
-+ For an overview of the application architecture see the [design canvas](./docs/application/Architecture.excalidraw)
-+ To see the attacks covered see the [edge definitions](./docs/edges/)
-+ To contribute a new attack to the project follow the [contribution guidelines](./CONTRIBUTING.md)
-
 ## Requirements
 
 ### Application

diff --git a/docs/logo.png b/docs/logo.png
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -7,6 +7,8 @@ plugins:
   - awesome-pages
 theme:
   name: material
+  logo: logo.png
+  favicon: logo.png
   palette:
       - scheme: default
         primary: black