Merge pull request #161 from KyoriPowered/feat/opengraph

Add opengraph previews to site
KyoriPowered · Feb 3, 2024 · 82a07ee · 82a07ee
2 parents bbafb6a + 4ffc0ed
commit 82a07ee
Show file tree

Hide file tree

Showing 4 changed files with 110 additions and 88 deletions.
diff --git a/Pipfile b/Pipfile
@@ -17,6 +17,7 @@ pygments = "*"
 sphinx-github-role = { git = "https://github.com/astrojuanlu/sphinx-github-role.git", ref = "main", editable = true }
 myst-parser = "*"
 sphinxcontrib-spelling = "*"
+sphinxext-opengraph = "*"
 
 [dev-packages]
 

diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/source/_static/logo-notext.png b/source/_static/logo-notext.png
diff --git a/source/conf.py b/source/conf.py
@@ -60,9 +60,12 @@
 
     Please consult the pull request to view any discussion and existing reviews.
 """
+        html_baseurl = f"https://kyoripowered.github.io/adventure-docs-previews/pull/{pr_number}/"
     else:
         html_baseurl = "https://docs.advntr.dev/"
 
+    ogp_site_url = html_baseurl
+
 # -- General configuration ---------------------------------------------------
 
 # Add local extensions
@@ -79,6 +82,7 @@
   'sphinx_reredirects',
   'sphinx_github_role',
   'sphinx_copybutton',
+  'sphinxext.opengraph',
   'minimessage_hl',
   'myst_parser',
   'adventure_docs_extensions'
@@ -156,3 +160,10 @@
 spelling_word_list_filename='../.config/spelling_wordlist.txt'
 spelling_show_suggestions=True
 spelling_suggestion_limit=5
+
+# sphinxext-opengraph
+
+ogp_image = "_static/logo-notext.png"
+ogp_social_cards = {
+    "enable": False
+}