Update documentation configuration and structure for improved navigat…

…ion and theme integration
dibe-sh · Nov 12, 2024 · 6a6f2ec · 6a6f2ec
1 parent ac526ac
commit 6a6f2ec
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 23 deletions.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1,10 +1,12 @@
-remote_theme: "mmistakes/minimal-mistakes"
-plugins:
-  - jekyll-toc
+remote_theme: "just-the-docs/just-the-docs"
 
-toc: true
-toc_label: "Contents"
-toc_icon: "align-left"
-toc_sticky: true
+color_scheme: "dark"
 
-minimal_mistakes_skin: "dark"
+just_the_docs:
+  show_on_navigation: true
+  show_last_modified_date: true
+  show_breadcrumbs: true
+  collapse_level: 2
+  aux_links:
+    "GitHub Repository": https://github.com/dibe-sh/cleaner
+    "Contact Support": mailto:contact@dibe.sh
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -1,8 +1,7 @@
 ---
 title: "Configuration Guide"
-toc: true
-toc_label: "Table of Contents"
-toc_icon: "align-left"
+layout: default
+nav_order: 4  
 ---
 
 # Configuration Guide

diff --git a/docs/examples.md b/docs/examples.md
@@ -1,8 +1,7 @@
 ---
 title: "Examples"
-toc: true
-toc_label: "Table of Contents"
-toc_icon: "align-left"
+layout: default
+nav_order: 5  
 ---
 
 # Examples

diff --git a/docs/index.md b/docs/index.md
@@ -1,8 +1,7 @@
 ---
 title: "Cleaner"
-toc: true
-toc_label: "Table of Contents"
-toc_icon: "align-left"
+layout: default
+nav_order: 1  
 ---
 
 # Cleaner

diff --git a/docs/setup.md b/docs/setup.md
@@ -1,8 +1,7 @@
 ---
 title: "Setup Instructions"
-toc: true
-toc_label: "Table of Contents"
-toc_icon: "align-left"
+layout: default
+nav_order: 2  
 ---
 
 # Setup Instructions

diff --git a/docs/usage.md b/docs/usage.md
@@ -1,8 +1,7 @@
 ---
 title: "Usage Guide"
-toc: true
-toc_label: "Table of Contents"
-toc_icon: "align-left"
+layout: default
+nav_order: 3  
 ---
 
 # Usage Guide