some fixes...but not enough

Author: SpectraL519

README.md

@@ -1,4 +1,4 @@
-<p align="center">
+<!-- <p align="center">
   <a href="https://github.com/SpectraL519/cpp-gl">
     <img src="docs/img/cpp-gl-hex.png" alt="CPP-GL" width="360" />
   </a>
@@ -13,6 +13,23 @@
 [![format](https://github.com/SpectraL519/cpp-gl/actions/workflows/format.yaml/badge.svg)](https://github.com/SpectraL519/cpp-gl/actions/workflows/format)
 [![benchmarks](https://github.com/SpectraL519/cpp-gl/actions/workflows/benchmarks.yaml/badge.svg)](https://github.com/SpectraL519/cpp-gl/actions/workflows/benchmarks.yaml)
 
+</div> -->
+
+<div align="center">
+
+![CPP-GL](docs/img/cpp-gl-hex.png){ width="360" }
+
+</div>
+
+<br />
+
+<div align="center">
+
+[![g++](https://github.com/SpectraL519/cpp-gl/actions/workflows/gpp.yaml/badge.svg)](https://github.com/SpectraL519/cpp-gl/actions/workflows/g++)
+[![clang++](https://github.com/SpectraL519/cpp-gl/actions/workflows/clang.yaml/badge.svg)](https://github.com/SpectraL519/cpp-gl/actions/workflows/clang++)
+[![format](https://github.com/SpectraL519/cpp-gl/actions/workflows/format.yaml/badge.svg)](https://github.com/SpectraL519/cpp-gl/actions/workflows/format)
+[![benchmarks](https://github.com/SpectraL519/cpp-gl/actions/workflows/benchmarks.yaml/badge.svg)](https://github.com/SpectraL519/cpp-gl/actions/workflows/benchmarks.yaml)
+
 </div>
 
 <br />

include/gl/graph.hpp

@@ -76,19 +76,17 @@ struct to_impl;
 ///
 /// ### Mathematics
 /// Inline math: \f$V = E - F + 2\f$
-/// Big-O: \f$\mathcal{O}(\vert V \vert + \vert E \vert)\f$
+/// Big-O: \f$\mathcal{O}(|V| + |E|)\f$
 ///
 /// Display math:
-///
-/// $$
-/// \sum_{v \in V} \text{deg}(v) = 2 \vert E \vert
-/// $$
+/// ```math
+/// \sum_{v \in V} \text{deg}(v) = 2 |E|
+/// ```
 ///
 /// Complex environment:
-///
-/// $$
-/// A_{i,j} = \begin{cases} 1 & \text{if } (i,j) \in E \\\\ 0 & \text{otherwise} \end{cases}
-/// $$
+/// ```math
+/// A_{i,j} = \begin{cases} 1 & \text{if } (i,j) \in E \\ 0 & \text{otherwise} \end{cases}
+/// ```
 ///
 /// ### Code Example
 /// ```cpp
@@ -105,9 +103,9 @@ struct to_impl;
 /// ```
 ///
 /// ### References
-/// For a general overview and integration instructions, see the [Project Overview](README.md#overview)
-/// or the [Installation Guide](README.md#installing-the-library).
-/// A simple reference [MAIN PAGE](README.md)
+/// For a general overview and integration instructions, see the [Project Overview](/#overview)
+/// or the [Installation Guide](/#installing-the-library).
+/// A simple reference [MAIN PAGE](/)
 ///
 /// > [!WARNING]
 /// > This class relies on its internal implementation tag to correctly define its layout. Modifying

mkdocs.yml

@@ -7,20 +7,18 @@ theme:
   logo: docs/img/cpp-gl-hex.png
   favicon: docs/img/cpp-gl-hex.png
   features:
-    - navigation.tabs # Top-level navigation tabs
-    - navigation.sections # Collapsible side-menu sections
+    - navigation.tabs
+    - navigation.sections
     - search.suggest
     - search.highlight
-    - content.code.copy # Copy buttons on code blocks
+    - content.code.copy
   palette:
-    # Light Mode
     - media: "(prefers-color-scheme: light)"
       scheme: default
       primary: indigo
       toggle:
         icon: material/brightness-7
         name: Switch to dark mode
-    # Dark Mode
     - media: "(prefers-color-scheme: dark)"
       scheme: slate
       primary: indigo
@@ -31,28 +29,32 @@ theme:
 markdown_extensions:
   - admonition
   - tables
-  - md_in_html          # <-- FIX FOR BADGES
+  - md_in_html
+  - attr_list # <-- NEW: Allows resizing markdown images
   - pymdownx.details
-  - pymdownx.superfences
   - pymdownx.arithmatex:
       generic: true
-  - pymdownx.snippets:  # <-- FIX FOR README DUPLICATION
+  - pymdownx.superfences:
+      custom_fences:
+        # <-- NEW: Creates a safe 'math' codeblock that Doxygen won't touch
+        - name: math
+          class: arithmatex
+          format: !!python/name:pymdownx.arithmatex.fence_mathjax_format
+  - pymdownx.snippets:
       base_path: "."
-      check_paths: true # Attempts to fix image paths when injecting
+      check_paths: true
 
 plugins:
   - search
+  - callouts # <-- NEW: Parses GitHub > [!WARNING] syntax natively
   - mkdoxy:
       projects:
         cpp-gl:
-          src-dirs: include # The directory to scan
+          src-dirs: include
           full-doc: True
           doxy-cfg:
-            # You can override Doxyfile settings here if needed,
-            # or MkDoxy will just use your existing Doxyfile.
             PROJECT_NAME: "CPP-GL"
 
-# Inject MathJax for LaTeX rendering
 extra_javascript:
   - scripts/mathjax.js
   - https://polyfill.io/v3/polyfill.min.js?features=es6

pyproject.toml

@@ -6,6 +6,7 @@ readme = "README.md"
 requires-python = ">=3.14"
 dependencies = [
     "mkdocs>=1.6.1",
+    "mkdocs-callouts>=1.16.0",
     "mkdocs-material>=9.7.6",
     "mkdoxy>=1.2.8",
 ]