fix markdown files + add nav

potassco · Dec 4, 2024 · c2db72b · c2db72b
1 parent 8217cb0
commit c2db72b
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 18 deletions.
diff --git a/.gitignore b/.gitignore
@@ -34,3 +34,4 @@ build
 .coverage
 _build
 _autosummary
+site
diff --git a/docs/community/help.md b/docs/community/help.md
@@ -1,6 +1,6 @@
-______________________________________________________________________
-
-## icon: material/help-circle
+---
+icon: material/help-circle
+---
 
 # Help
 

diff --git a/docs/index.md b/docs/index.md
@@ -1,13 +1,9 @@
-______________________________________________________________________
-
-```
+---
 title: Home
 hide:
     - navigation
     - toc
-```
-
-______________________________________________________________________
+---
 
 # fillname
 

diff --git a/docs/reference/api/index.md b/docs/reference/api/index.md
@@ -1,5 +1,6 @@
-______________________________________________________________________
-
-## icon: material/book-open-variant
+---
+title: "API Reference"
+icon: "material/book-open-variant"
+---
 
 # API
diff --git a/docs/reference/encodings/index.md b/docs/reference/encodings/index.md
@@ -1,5 +1,5 @@
-______________________________________________________________________
-
-## icon: material/file-code
+---
+icon: material/file-code
+---
 
 # Encodings
diff --git a/docs/reference/problem/index.md b/docs/reference/problem/index.md
@@ -1,5 +1,5 @@
-______________________________________________________________________
-
-## icon: material/head-dots-horizontal
+---
+icon: material/head-dots-horizontal
+---
 
 # Problem specification
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -65,6 +65,7 @@ extra:
     - icon: potassco-logo
       link: https://potassco.org
   generator: false
+
 markdown_extensions:
   - admonition
   - pymdownx.details
@@ -109,3 +110,20 @@ plugins:
             show_inherited_detail_toc: true
             show_inherited_detail_tree: true
             show_source: false
+
+nav:
+  - Home: index.md
+  - Getting Started: getting_started.md
+  - Examples: examples/index.md
+  - Reference:
+    - reference/index.md
+    - Problem: reference/problem/index.md
+    - Encodings: reference/encodings/index.md
+    - API: reference/api/index.md
+  - Community:
+    - community/index.md
+    - Help: community/help.md
+    - Changes: community/CHANGES.md
+    - Contributing: community/CONTRIBUTING.md
+    - Development: community/DEVELOPMENT.md
+    - Deployment: community/DEPLOYMENT.md
-Original file line number
+Diff line change
@@ Expand Up / @@ -34,3 +34,4 @@ build @@
     .coverage
     _build
     _autosummary
+    site