From 1d4068b7758ec9e7b2c5362c8469198bb6882840 Mon Sep 17 00:00:00 2001 From: Daniel Salazar Date: Thu, 9 Mar 2023 14:51:28 -0500 Subject: [PATCH] feat(doc): #940 doc theme - Improve doc theme --- README.md | 2 +- docs/mkdocs.yaml | 7 ++++++- static/makes.svg => docs/src/assets/demo.svg | 0 docs/src/assets/favicon.svg | 3 +++ 4 files changed, 10 insertions(+), 2 deletions(-) rename static/makes.svg => docs/src/assets/demo.svg (100%) create mode 100644 docs/src/assets/favicon.svg diff --git a/README.md b/README.md index 09a4a5d6c..a5e5f8669 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ A software supply chain framework powered by [Nix][nix]. -![Makes example](/static/makes.svg "Makes example") +![Makes demo](/docs/src/assets/favicon.svg "Makes demo") Ever needed to run applications locally to try out your code? diff --git a/docs/mkdocs.yaml b/docs/mkdocs.yaml index 4ebefa7b4..d02f5ffd9 100644 --- a/docs/mkdocs.yaml +++ b/docs/mkdocs.yaml @@ -1,4 +1,4 @@ -site_name: 🦄 Makes +site_name: Makes Documentation site_url: https://fluidattacks.github.io/makes/ site_description: Documentation for Makes site_author: Fluid Attacks @@ -41,6 +41,11 @@ strict: true docs_dir: src theme: name: material + logo: assets/favicon.svg + favicon: assets/favicon.svg + palette: + primary: deep purple + accent: purple features: - content.code.copy - navigation.instant diff --git a/static/makes.svg b/docs/src/assets/demo.svg similarity index 100% rename from static/makes.svg rename to docs/src/assets/demo.svg diff --git a/docs/src/assets/favicon.svg b/docs/src/assets/favicon.svg new file mode 100644 index 000000000..22cf40bba --- /dev/null +++ b/docs/src/assets/favicon.svg @@ -0,0 +1,3 @@ + + 🦄 +