Skip to content

Commit 72ed776

Browse files
committed
enable mermaid in doxy?
1 parent 5e594ea commit 72ed776

File tree

3 files changed

+16
-4
lines changed

3 files changed

+16
-4
lines changed

docs/doxygen/doxygen-config

+3-3
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ TAB_SIZE = 4
289289
# with the commands \{ and \} for these it is advised to use the version @{ and
290290
# @} or use a double escape (\\{ and \\})
291291

292-
ALIASES =
292+
ALIASES = mermaid{1}="@htmlonly <div class=\"mermaid\"> ^^ @endhtmlonly @htmlinclude \"\1.mmd\" @htmlonly ^^ </div> @endhtmlonly"
293293

294294
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
295295
# only. Doxygen will then generate output that is more tailored for C. For
@@ -1046,7 +1046,7 @@ EXCLUDE_SYMBOLS =
10461046
# that contain example code fragments that are included (see the \include
10471047
# command).
10481048

1049-
EXAMPLE_PATH =
1049+
EXAMPLE_PATH = graphs
10501050

10511051
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
10521052
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
@@ -1297,7 +1297,7 @@ HTML_HEADER = ./docs/doxygen/doxygen-custom/header.html
12971297
# that doxygen normally uses.
12981298
# This tag requires that the tag GENERATE_HTML is set to YES.
12991299

1300-
HTML_FOOTER =
1300+
HTML_FOOTER = ./docs/doxygen/doxygen-custom/footer.html
13011301

13021302
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
13031303
# sheet that is used by each HTML page. It can be used to fine-tune the look of
+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<script>
2+
mermaid.initialize({
3+
startOnLoad: true,
4+
theme: 'base',
5+
themeVariables: {
6+
primaryColor: '#f4f4ff',
7+
secondaryColor: 'rgba(244,244,255,0.9)',
8+
tertiaryColor: '#F9FAFC',
9+
},
10+
});
11+
</script>

docs/doxygen/doxygen-custom/header.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@
3636
</head>
3737

3838
<body>
39-
39+
<!-- KDB - trying to add mermaid -->
40+
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
4041
<!-- https://tholman.com/github-corners/ -->
4142
<a href="https://github.com/sparkfun/SparkFun_Toolkit" class="github-corner" title="View source on GitHub">
4243
<svg viewBox="0 0 250 250" style="position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true">

0 commit comments

Comments
 (0)