Add recommender overlay

Signed-off-by: Jay Wang <jay@zijie.wang>
poloclub · Oct 3, 2023 · e7b4107 · e7b4107
1 parent 1756191
commit e7b4107
Show file tree

Hide file tree

Showing 5 changed files with 62 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,6 @@
 test*.ipynb
 .ipynb_checkpoints
 Pipfile.lock
-explorer/*/*.ndjson
+explorer/*/*.ndjson
+_site
+Gemfile.lock
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1 @@
+gem "just-the-docs"
diff --git a/_config.yml b/_config.yml
@@ -1,5 +1,6 @@
+theme: just-the-docs
 remote_theme: just-the-docs/just-the-docs
-title: "DiffusionDB"
+title: 'DiffusionDB'
 
 # Enable or disable the site search
 # Supports true (default) or false
@@ -30,7 +31,6 @@ search:
 
 color_scheme: light
 
-
 # External navigation links
 nav_external_links:
   - title: DiffusionDB on GitHub

diff --git a/_includes/head_custom.html b/_includes/head_custom.html
@@ -1,3 +1,7 @@
 <link rel="shortcut icon" type="image/png" href="favicon.ico" />
 <meta property="og:image" content="https://i.imgur.com/vNrixuh.png" />
 <meta property="twitter:image" content="https://i.imgur.com/vNrixuh.png" />
+<script
+  type="module"
+  src="https://unpkg.com/recommender-overlay/dist/recommender-overlay.es.js"
+></script>
diff --git a/_layouts/default.html b/_layouts/default.html
@@ -0,0 +1,52 @@
+---
+layout: table_wrappers
+---
+
+<!DOCTYPE html>
+
+<html lang="{{ site.lang | default: 'en-US' }}">
+{% include head.html %}
+<body>
+  <a class="skip-to-main" href="#main-content">Skip to main content</a>
+  {% include icons/icons.html %}
+  {% include components/sidebar.html %}
+  <div class="main" id="top">
+    {% include components/header.html %}
+    <div class="main-content-wrap">
+      {% include components/breadcrumbs.html %}
+      <div id="main-content" class="main-content">
+        <main>
+          {% if site.heading_anchors != false %}
+            {% include vendor/anchor_headings.html html=content beforeHeading="true" anchorBody="<svg viewBox=\"0 0 16 16\" aria-hidden=\"true\"><use xlink:href=\"#svg-link\"></use></svg>" anchorClass="anchor-heading" anchorAttrs="aria-labelledby=\"%html_id%\"" %}
+          {% else %}
+            {{ content }}
+          {% endif %}
+
+          {% if page.has_children == true and page.has_toc != false %}
+            {% include components/children_nav.html %}
+          {% endif %}
+        </main>
+        {% include components/footer.html %}
+      </div>
+    </div>
+    {% if site.search_enabled != false %}
+      {% include components/search_footer.html %}
+    {% endif %}
+  </div>
+
+  {% if site.mermaid %}
+    {% include components/mermaid.html %}
+  {% endif %}
+
+  <recommender-overlay
+    my-brand="DiffusionDB"
+    brands-to-ignore="CNN 101"
+    recommendation-count="10"
+    similar-candidate-count="15"
+    position-left="30"
+    display-delay="15000"
+    homepage-url="https://poloclub.github.io/"
+  ></recommender-overlay>
+
+</body>
+</html>