EthicalAd: specific placement for Antora and mdBook (#475)

![Screenshot_2024-12-18_16-55-02](https://github.com/user-attachments/assets/61283e23-6df4-4e78-b472-c46c2430a544) Based on #473
readthedocs · Jan 22, 2025 · 1a729a4 · 1a729a4
1 parent 24287b8
commit 1a729a4
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -47,6 +47,7 @@ We maintain a list of examples to check our JavaScript client is working correct
 * `Docusaurus <https://test-builds.readthedocs.io/en/docusaurus/>`_
 * `Jekyll <https://test-builds.readthedocs.io/en/jekyll/>`_
 * `Jupyter Book <https://test-builds.readthedocs.io/en/jupyter-book/>`_
+* `mdBook <https://test-builds.readthedocs.io/en/mdbook/>`_
 * `MkDocs <https://test-builds.readthedocs.io/en/mkdocs/>`_
 * `MkDocs (Material theme) <https://test-builds.readthedocs.io/en/mkdocs-material/>`_
 * `MkDocs (Terminal theme) <https://test-builds.readthedocs.io/en/mkdocs-terminal/>`_

diff --git a/src/doctools.css b/src/doctools.css
@@ -6,28 +6,37 @@
  * values.
  **/
 @layer defaults {
+  :root[data-readthedocs-tool="docusaurus"] {
+    --readthedocs-flyout-header-font-size: 0.9rem;
+  }
+
   :root[data-readthedocs-tool="mkdocs-material"] {
     --readthedocs-font-size: 0.58rem;
+    --readthedocs-flyout-header-font-size: 0.7rem;
     --readthedocs-flyout-font-size: 0.58rem;
   }
 
   :root[data-readthedocs-tool="antora"] {
     --readthedocs-font-size: 0.7rem;
+    --readthedocs-flyout-header-font-size: 0.8rem;
     --readthedocs-flyout-font-size: 0.7rem;
   }
 
   :root[data-readthedocs-tool="mdbook"] {
     --readthedocs-font-size: 1.3rem;
+    --readthedocs-flyout-header-font-size: 1.5rem;
     --readthedocs-flyout-font-size: 1.3rem;
   }
 
   :root[data-readthedocs-tool="sphinx"][data-readthedocs-tool-theme="furo"] {
     --readthedocs-font-size: 0.725rem;
+    --readthedocs-flyout-header-font-size: 0.845rem;
     --readthedocs-flyout-font-size: 0.725rem;
   }
 
   :root[data-readthedocs-tool="sphinx"][data-readthedocs-tool-theme="immaterial"] {
     --readthedocs-font-size: 0.58rem;
+    --readthedocs-flyout-header-font-size: 0.7rem;
     --readthedocs-flyout-font-size: 0.58rem;
   }
 }
diff --git a/src/ethicalads.js b/src/ethicalads.js
@@ -147,6 +147,28 @@ export class EthicalAdsAddon extends AddonBase {
           placement.classList.add("ethical-alabaster");
           placement.classList.add("ethical-docsify");
 
+          placement.setAttribute("data-ea-type", "readthedocs-sidebar");
+          placement.setAttribute("data-ea-style", "image");
+          knownPlacementFound = true;
+        }
+      } else if (docTool.isAntora()) {
+        selector = "aside nav.nav-menu";
+        element = document.querySelector(selector);
+
+        if (this.elementAboveTheFold(element)) {
+          placement.classList.add("ethical-alabaster");
+
+          placement.setAttribute("data-ea-type", "readthedocs-sidebar");
+          placement.setAttribute("data-ea-style", "image");
+          knownPlacementFound = true;
+        }
+      } else if (docTool.isMdBook()) {
+        selector = "nav#sidebar mdbook-sidebar-scrollbox";
+        element = document.querySelector(selector);
+
+        if (this.elementAboveTheFold(element)) {
+          placement.classList.add("ethical-alabaster");
+
           placement.setAttribute("data-ea-type", "readthedocs-sidebar");
           placement.setAttribute("data-ea-style", "image");
           knownPlacementFound = true;