Add opengraph tags in <head>

irskep · Sep 2, 2024 · 67f06cf · 67f06cf
1 parent 2382701
commit 67f06cf
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 0 deletions.
diff --git a/docs/djockey.yaml b/docs/djockey.yaml
@@ -9,6 +9,8 @@ output_dir:
 project_info:
   version: 0.1.1
   github_url: https://github.com/irskep/djockey
+  description: "A powerful static site generator for technical writing and project documentation"
+  image: static/silly_logo.png
 
 link_mappings:
   - path: src/typescript_link_mapping.json

diff --git a/docs/src/basics/configuration.dj b/docs/src/basics/configuration.dj
@@ -22,6 +22,8 @@ url_root: "https://your-docs-site-here"
 project_info:
   version: 0.0.1
   github_url: https://github.com/your/project
+  description: "Site description for social media"
+  image: "Path to image inside your docs directory for social media"
 input_dir: "path to your docs"
 output_dir:
   html: "path to your HTML output"

diff --git a/docs/src/static/silly_logo.png b/docs/src/static/silly_logo.png
diff --git a/src/types.ts b/src/types.ts
@@ -13,6 +13,8 @@ export type DjockeyConfig = {
   project_info?: {
     version?: string;
     github_url?: string;
+    description?: string;
+    image?: string;
   };
 
   num_passes: number;

diff --git a/templates/html/base.njk b/templates/html/base.njk
@@ -54,6 +54,16 @@
       {%- endif %}
     {% endfor %}
     <title>{{ config.site_name }} - {{ doc.title }}</title>
+
+    <meta property="og:type" content="website">
+    <meta property="og:url" content="{{ config.url_root }}">
+    <meta property="og:title" content="{{ config.site_name }} - {{ doc.title }}">
+    {% if config.project_info.description -%}
+    <meta property="og:description" content="{{ config.project_info.description }}">
+    {%- endif %}
+    {% if config.project_info.image -%}
+    <meta property="og:image" content="{{ config.url_root }}/{{ config.project_info.image }}">
+    {%- endif %}
   </head>
   <body>
     <header class="DJHeader">