diff --git a/docs/djockey.yaml b/docs/djockey.yaml
index 5f8e4d2..c3540b8 100644
--- 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
index 8cfb26b..bfd5a95 100644
--- 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
new file mode 100644
index 0000000..9ad9517
Binary files /dev/null and b/docs/src/static/silly_logo.png differ
diff --git a/src/types.ts b/src/types.ts
index 4521e53..63f7266 100644
--- 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
index 15d8540..65bffb2 100644
--- 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">