use doxygen-awesome css for alerts

Tsche · Feb 15, 2024 · 02eae56 · 02eae56
1 parent a357a69
commit 02eae56
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 117 deletions.
diff --git a/docs/Doxyfile b/docs/Doxyfile
@@ -1315,8 +1315,7 @@ HTML_EXTRA_STYLESHEET  = docs/style/doxygen-awesome.css \
                          docs/style/doxygen-awesome-sidebar-only.css \
                          docs/style/doxygen-awesome-sidebar-only-darkmode-toggle.css \
                          docs/github-corner.css \
-                         doxygen-awesome/doxygen-awesome-godbolt.css \
-                         doxygen-awesome/doxygen-awesome-alerts.css
+                         doxygen-awesome/doxygen-awesome-godbolt.css
 
 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
 # other source files which should be copied to the HTML output directory. Note

diff --git a/docs/alerts.md b/docs/alerts.md
@@ -8,7 +8,6 @@ The `doxygen-awesome-alerts` extension provides support for GitHub's alert synta
 
 ## Installation
 * Ensure you have doxygen-awesome properly configured for this project
-* Add `doxygen-awesome/doxygen-awesome-alerts.css` to `HTML_EXTRA_STYLESHEET` in your Doxyfile
 * Add `doxygen-awesome/doxygen-awesome-alerts.js` to `HTML_EXTRA_FILES` in your Doxyfile
 
 > [!TIP]

diff --git a/doxygen-awesome/doxygen-awesome-alerts.css b/doxygen-awesome/doxygen-awesome-alerts.css
diff --git a/doxygen-awesome/doxygen-awesome-alerts.js b/doxygen-awesome/doxygen-awesome-alerts.js
@@ -6,55 +6,54 @@
 class DoxygenAwesomeAlerts {
   static alerts = {
     '[!NOTE]': {
-      'text': 'Note',
-      'class': 'markdown-alert-note',
-      'path':
+      text: 'Note',
+      class: 'note',
+      path:
           'M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z'
     },
     '[!TIP]': {
-      'text': 'Tip',
-      'class': 'markdown-alert-tip',
-      'path':
+      text: 'Tip',
+      class: 'invariant',
+      path:
           'M8 1.5c-2.363 0-4 1.69-4 3.75 0 .984.424 1.625.984 2.304l.214.253c.223.264.47.556.673.848.284.411.537.896.621 1.49a.75.75 0 0 1-1.484.211c-.04-.282-.163-.547-.37-.847a8.456 8.456 0 0 0-.542-.68c-.084-.1-.173-.205-.268-.32C3.201 7.75 2.5 6.766 2.5 5.25 2.5 2.31 4.863 0 8 0s5.5 2.31 5.5 5.25c0 1.516-.701 2.5-1.328 3.259-.095.115-.184.22-.268.319-.207.245-.383.453-.541.681-.208.3-.33.565-.37.847a.751.751 0 0 1-1.485-.212c.084-.593.337-1.078.621-1.489.203-.292.45-.584.673-.848.075-.088.147-.173.213-.253.561-.679.985-1.32.985-2.304 0-2.06-1.637-3.75-4-3.75ZM5.75 12h4.5a.75.75 0 0 1 0 1.5h-4.5a.75.75 0 0 1 0-1.5ZM6 15.25a.75.75 0 0 1 .75-.75h2.5a.75.75 0 0 1 0 1.5h-2.5a.75.75 0 0 1-.75-.75Z'
     },
     '[!IMPORTANT]': {
-      'text': 'Important',
-      'class': 'markdown-alert-important',
-      'path':
+      text: 'Important',
+      class: 'todo',
+      path:
           'M0 1.75C0 .784.784 0 1.75 0h12.5C15.216 0 16 .784 16 1.75v9.5A1.75 1.75 0 0 1 14.25 13H8.06l-2.573 2.573A1.458 1.458 0 0 1 3 14.543V13H1.75A1.75 1.75 0 0 1 0 11.25Zm1.75-.25a.25.25 0 0 0-.25.25v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25Zm7 2.25v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 9a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z'
     },
     '[!WARNING]': {
-      'text': 'Warning',
-      'class': 'markdown-alert-warning',
-      'path':
+      text: 'Warning',
+      class: 'warning',
+      path:
           'M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z'
     },
     '[!CAUTION]': {
-      'text': 'Caution',
-      'class': 'markdown-alert-caution',
-      'path':
+      text: 'Caution',
+      class: 'bug',
+      path:
           'M4.47.22A.749.749 0 0 1 5 0h6c.199 0 .389.079.53.22l4.25 4.25c.141.14.22.331.22.53v6a.749.749 0 0 1-.22.53l-4.25 4.25A.749.749 0 0 1 11 16H5a.749.749 0 0 1-.53-.22L.22 11.53A.749.749 0 0 1 0 11V5c0-.199.079-.389.22-.53Zm.84 1.28L1.5 5.31v5.38l3.81 3.81h5.38l3.81-3.81V5.31L10.69 1.5ZM8 4a.75.75 0 0 1 .75.75v3.5a.75.75 0 0 1-1.5 0v-3.5A.75.75 0 0 1 8 4Zm0 8a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z'
     }
   };
 
   static get_alert(config) {
-    let alert = document.createElement('h3');
-    alert.className = 'markdown-alert-title';
+    const alert = document.createElement('dt');
 
-    let svg = document.createElementNS('http://www.w3.org/2000/svg', 'svg');
-    svg.setAttribute('class', config['class']);
+    const svg = document.createElementNS('http://www.w3.org/2000/svg', 'svg');
+    svg.setAttribute('fill', `var(--${config['class']}-color-dark)`);
     svg.setAttribute('viewBox', '0 0 16 16');
     svg.setAttribute('width', '16');
     svg.setAttribute('height', '16');
     svg.ariaHidden = true;
 
-    let path = document.createElementNS('http://www.w3.org/2000/svg', 'path');
-    path.setAttribute('d', config['path']);
+    const path = document.createElementNS('http://www.w3.org/2000/svg', 'path');
+    path.setAttribute('d', config.path);
     svg.appendChild(path);
 
-    let title = document.createElement('span');
-    title.innerHTML = config['text'];
-
+    const title = document.createElement('span');
+    title.setAttribute('style', 'line-height: 16px; vertical-align: top;')
+    title.innerHTML = ` ${config.text}`;
     alert.appendChild(svg);
     alert.append(title);
 
@@ -63,10 +62,11 @@ class DoxygenAwesomeAlerts {
 
   static init() {
     $(() => {
-      const blockquotes = document.getElementsByTagName('blockquote');
-      for (const blockquote of blockquotes) {
+      let blockquotes = Array.from(document.getElementsByTagName('blockquote'));
+      for (let blockquote of blockquotes) {
         let first_paragraph = blockquote.getElementsByTagName('p')[0];
         let text            = first_paragraph.innerHTML.trimStart();
+
         if (text.charCodeAt(0) == 8205) {
           // remove zero-width joiner if there is one
           text = text.slice(1);
@@ -88,22 +88,30 @@ class DoxygenAwesomeAlerts {
           // could not find tag, bail out
           continue;
         }
+
         // remove tag from text
-        first_paragraph.innerHTML = text.slice(tag.length);
+        first_paragraph.innerHTML = text.slice(tag.length).trimStart();
         const first_element = first_paragraph.firstElementChild
         if (first_element && first_element.tagName == 'BR') {
-          console.log(first_element.tagName)
           // sometimes a line break is inserted at the start of this node
           // not sure why
           first_element.remove();
         }
+
+        const dl = document.createElement("dl");
+        dl.classList.add("section");
+        dl.classList.add(info['class']);
+
+        const title = DoxygenAwesomeAlerts.get_alert(info);
+        dl.appendChild(title);
 
-        // add alert line
-        const alert = DoxygenAwesomeAlerts.get_alert(info);
-        first_paragraph.prepend(alert);
+        const content = document.createElement("dd");
+        for (let child of Array.from(blockquote.children)) {
+          content.appendChild(child.cloneNode(true));
+        }
+        dl.appendChild(content);
 
-        blockquote.classList.add('markdown-alert');
-        blockquote.classList.add(info['class']);
+        blockquote.replaceWith(dl);
       }
     })
   }