From bf2e9d0088239b9953580cc29632d11cbc43996a Mon Sep 17 00:00:00 2001
From: Ayush Chaurasia <ayush.chaurarsia@gmail.com>
Date: Wed, 21 Feb 2024 23:22:47 +0530
Subject: [PATCH] Docs: add meta tags (#1006)

---
 docs/mkdocs.yml               | 11 ++++++++++-
 docs/requirements.txt         |  3 ++-
 docs/src/extra_js/meta_tag.js |  6 ------
 python/pyproject.toml         |  2 +-
 4 files changed, 13 insertions(+), 9 deletions(-)
 delete mode 100644 docs/src/extra_js/meta_tag.js

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index fd2be5e7..0deaaeb4 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -57,6 +57,16 @@ plugins:
           - https://arrow.apache.org/docs/objects.inv
           - https://pandas.pydata.org/docs/objects.inv
 - mkdocs-jupyter
+- ultralytics:
+    verbose: True
+    enabled: True
+    default_image: "assets/lancedb_and_lance.png" # Default image for all pages
+    add_image: True # Automatically add meta image
+    add_keywords: True # Add page keywords in the header tag
+    add_share_buttons: True # Add social share buttons
+    add_authors: False # Display page authors 
+    add_desc: False
+    add_dates: False
 
 markdown_extensions:
 - admonition
@@ -206,7 +216,6 @@ extra_css:
 
 extra_javascript:
   - "extra_js/init_ask_ai_widget.js"
-  - "extra_js/meta_tag.js"
 
 extra:
   analytics:
diff --git a/docs/requirements.txt b/docs/requirements.txt
index e5b8bbd3..7f34591e 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -2,4 +2,5 @@ mkdocs==1.5.3
 mkdocs-jupyter==0.24.1
 mkdocs-material==9.5.3
 mkdocstrings[python]==0.20.0
-pydantic
\ No newline at end of file
+pydantic
+mkdocs-ultralytics-plugin==0.0.44
\ No newline at end of file
diff --git a/docs/src/extra_js/meta_tag.js b/docs/src/extra_js/meta_tag.js
deleted file mode 100644
index b1349980..00000000
--- a/docs/src/extra_js/meta_tag.js
+++ /dev/null
@@ -1,6 +0,0 @@
-window.addEventListener('load', function() {
-    var meta = document.createElement('meta');
-    meta.setAttribute('property', 'og:image');
-    meta.setAttribute('content', '/assets/lancedb_and_lance.png');
-    document.head.appendChild(meta);
-  });
\ No newline at end of file
diff --git a/python/pyproject.toml b/python/pyproject.toml
index cea93e94..36278df7 100644
--- a/python/pyproject.toml
+++ b/python/pyproject.toml
@@ -50,7 +50,7 @@ repository = "https://github.com/lancedb/lancedb"
 [project.optional-dependencies]
 tests = ["aiohttp", "pandas>=1.4", "pytest", "pytest-mock", "pytest-asyncio", "duckdb", "pytz", "polars>=0.19"]
 dev = ["ruff", "pre-commit"]
-docs = ["mkdocs", "mkdocs-jupyter", "mkdocs-material", "mkdocstrings[python]"]
+docs = ["mkdocs", "mkdocs-jupyter", "mkdocs-material", "mkdocstrings[python]", "mkdocs-ultralytics-plugin==0.0.44"]
 clip = ["torch", "pillow", "open-clip"]
 embeddings = ["openai>=1.6.1", "sentence-transformers", "torch", "pillow", "open-clip-torch", "cohere", "huggingface_hub",
                 "InstructorEmbedding", "google.generativeai", "boto3>=1.28.57", "awscli>=1.29.57", "botocore>=1.31.57"]