Siva | add theme override

Author: ysskrishna

docs/theme/overrides/main.html

@@ -0,0 +1,6 @@
+{% extends "base.html" %}
+
+{% block extrahead %}
+  {% include "partials/meta.html" %}
+  {{ super() }}
+{% endblock %}

docs/theme/overrides/partials/meta.html

@@ -0,0 +1,52 @@
+{# --- SET VARIABLES --- #}
+{% set description = (page.meta.description if page and page.meta else none) or config.site_description %}
+{% set title = (page.title if page and page.title else none) or config.site_name %}
+{% set raw_keywords = page.meta.keywords if page and page.meta and page.meta.keywords else config.extra.keywords %}
+{% if raw_keywords is iterable and raw_keywords is not string %}
+  {% set keywords = raw_keywords | join(', ') %}
+{% else %}
+  {% set keywords = raw_keywords %}
+{% endif %}
+
+<meta name="google-site-verification" content="{{ config.extra.google_site_verification }}" />
+<meta name="description" content="{{ description }}">
+{% if keywords %}
+  <meta name="keywords" content="{{ keywords }}">
+{% endif %}
+
+{# Open Graph Meta Tags #}
+<meta property="og:type" content="website">
+<meta property="og:url" content="{{ config.site_url }}/">
+<meta property="og:title" content="{{ title }}">
+<meta property="og:description" content="{{ description }}">
+<meta property="og:image" content="{{ config.extra.og_image }}">
+
+{# Twitter Card Meta Tags #}
+<meta property="twitter:card" content="summary_large_image">
+<meta property="twitter:url" content="{{ config.site_url }}/">
+<meta property="twitter:title" content="{{ title }}">
+<meta property="twitter:description" content="{{ description }}">
+<meta property="twitter:image" content="{{ config.extra.og_image }}">
+
+{# Robots Meta Tag #}
+<meta name="robots" content="index, follow">
+
+{# Structured Data (JSON-LD) #}
+<script type="application/ld+json">
+{
+  "@context": "https://schema.org",
+  "@type": "SoftwareApplication",
+  "name": "{{ title }}",
+  "description": "{{ description }}",
+  "applicationCategory": "DeveloperApplication",
+  "operatingSystem": "Cross-platform",
+  "author": {
+    "@type": "Person",
+    "name": "{{ config.site_author }}"
+  },
+  "programmingLanguage": "Python",
+  "url": "{{ config.site_url }}",
+  "codeRepository": "{{ config.repo_url }}"
+}
+</script>
+

docs/theme/overrides/partials/title.html

@@ -0,0 +1,5 @@
+{% if page and page.title %}
+  {{ page.title }} - {{ config.site_name }}
+{% else %}
+  {{ config.site_name }}
+{% endif %}

mkdocs.yml

@@ -29,6 +29,7 @@ plugins:
             merge_init_into_class: true
 theme:
   name: material
+  custom_dir: docs/theme/overrides
   locale: en
   features:
     - navigation.top
@@ -45,10 +46,46 @@ markdown_extensions:
       base_path: .
 
 extra:
+  google_site_verification: "ICfb1XMVpLJZcn7JdUoaUsNZ-0D8LH1uztDuFd0VNfM"
+  og_image: https://raw.githubusercontent.com/ysskrishna/nestedutils/main/media/og.png
+  keywords:
+    - nested
+    - nested-data
+    - nested-dict
+    - json-access
+    - json-utils
+    - dot-notation
+    - dot-access
+    - path-access
+    - keypath
+    - deep-get
+    - deep-set
+    - deep-access
+    - deep-delete
+    - safe-access
+    - KeyError
+    - no-keyerror
+    - key-error-handling
+    - dictionary
+    - dict
+    - list
+    - json
+    - config
+    - dict-utils
+    - data-utils
+    - config-utils
+    - utilities
+    - utils
+    - open source
+    - API reference
+    - contribution guide
+    - changelog
+    - version history
+    - MIT license
+    - ysskrishna
   social:
     - icon: fontawesome/brands/python
       link: https://pypi.org/project/nestedutils/
-
     - icon: fontawesome/solid/external-link
       link: https://ysskrishna.vercel.app
     - icon: fontawesome/brands/github