feat: add ogTags

hakuna16 · Sep 7, 2020 · 17a505d · 17a505d
1 parent 418fdf7
commit 17a505d
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 9 deletions.
diff --git a/fixtures/typescript/entity.ts b/fixtures/typescript/entity.ts
@@ -2,6 +2,7 @@ import { RecordError } from '../adapters/base-record'
 
 /**
  * Error which is thrown when there are validation errors with records
+ * @ogTitle Some title from tag
  * @category Errors
  */
 class ValidationError extends Error {

diff --git a/jsdoc.json b/jsdoc.json
@@ -21,7 +21,10 @@
     "templates": {
         "better-docs": {
             "name": "AdminBro Documentation",
-            "logo": "images/logo.png"
+            "logo": "images/logo.png",
+            "ogTags": {
+                "title": "some title"
+            }
         }
     }
 }
diff --git a/navigation.js b/navigation.js
@@ -1,17 +1,28 @@
+const availableOgTags = ['image', 'title', 'description', 'url', 'type', 'locale']
+
 exports.defineTags = (dictionary) => {
   dictionary.defineTag('category', {
     onTagged: (doclet, tag) => {
       doclet.category = tag.value
-    }
+    },
   })
   dictionary.defineTag('subcategory', {
     onTagged: (doclet, tag) => {
       doclet.subCategory = tag.value
-    }
+    },
   })
   dictionary.defineTag('section', {
     onTagged: (doclet, tag) => {
       doclet.section = tag.value
-    }
+    },
+  })
+
+  availableOgTags.forEach((tagName) => {
+    dictionary.defineTag(`og${tagName.toUpperCase()}`, {
+      onTagged: (doclet, tag) => {
+        doclet.ogTags = doclet.ogTags || {}
+        doclet.ogTags[tagName] = tag.value
+      },
+    })
   })
 }
diff --git a/src/better-docs.type.ts b/src/better-docs.type.ts
@@ -13,12 +13,16 @@ export type NavLink = {
 
 export type OgTags = {
   /**
-   * @ogTitle
-   * @ogDescription
-   * @ogImage
+   * Default value for @ogTitle tag
+   */
+  title?: string;
+  /**
+   * Default value for @ogDescription tags
    */
-  title: string;
   description: string;
+  /**
+   * Default value for @ogImage tags
+   */
   image: string;
 }
 

diff --git a/tmpl/head.tmpl b/tmpl/head.tmpl
@@ -1,5 +1,11 @@
 <?js 
   self = this
+  let tags = ['image', 'title', 'description', 'url', 'type', 'locale']
+  let ogTags = {}
+
+  tags.forEach(function (tag) {
+    ogTags[tag] = (doc && doc.ogTags && doc.ogTags[tag] || betterDocs.ogTags && betterDocs.ogTags[tag])
+  })
 ?>
 <head>
   <?js= betterDocs.trackingCode ?>
@@ -25,5 +31,10 @@
   <?js if (betterDocs.head) { ?>
     <?js= betterDocs.head ?>
   <?js } ?>
+  <?js Object.keys(ogTags).forEach( function(tagName) { ?>
+    <?js if (ogTags[tagName]) { ?>
+      <meta property="og:<?js= tagName ?>" content="<?js= ogTags[tagName] ?>" />
+    <?js } ?>
+  <?js }) ?>
 </head>
 
diff --git a/tmpl/layout.tmpl b/tmpl/layout.tmpl
@@ -16,7 +16,7 @@ var search = env.conf.templates && env.conf.templates.search
 
 <!DOCTYPE html>
 <html lang="en">
-<?js= this.partial('head.tmpl', { betterDocs, title }) ?>
+<?js= this.partial('head.tmpl', { betterDocs, title, doc }) ?>
 
 <body class="<?js= self.smallHeader ? 'layout small-header' : 'layout'?>">
     <div id="stickyNavbarOverlay"></div>