fix: add ogtags to sections

SoftwareBrothers · Sep 7, 2020 · b5b8305 · b5b8305
1 parent 54bd0c8
commit b5b8305
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 7 deletions.
diff --git a/fixtures/sections-json/sections.json b/fixtures/sections-json/sections.json
@@ -3,6 +3,9 @@
     "title": "First"
   },
   "designsystem": {
-    "title": "Design System"
+    "title": "Design System",
+    "ogTags": {
+      "title": "title from section"
+    }
   }
 }
diff --git a/publish.js b/publish.js
@@ -635,6 +635,7 @@ exports.publish = function (taffyData, opts, tutorials) {
           readme,
           subtitle: '',
           sections: decoratedSections,
+          docs: [section],
         }
 
         view.layout = 'layout.tmpl'

diff --git a/src/better-docs.type.ts b/src/better-docs.type.ts
@@ -13,17 +13,29 @@ export type NavLink = {
 
 export type OgTags = {
   /**
-   * Default value for @ogTitle tag
+   * Value for @ogTitle tag
    */
   title?: string;
   /**
-   * Default value for @ogDescription tags
+   * Value for @ogDescription tag
    */
-  description: string;
+  description?: string;
   /**
-   * Default value for @ogImage tags
+   * Value for @ogImage tag
    */
-  image: string;
+  image?: string;
+  /**
+   * Value for @ogLocale tag
+   */
+  locale?: string;
+  /**
+   * Value for @ogUrl tag
+   */
+  url?: string;
+  /**
+   * Value for @ogType tag
+   */
+  type?: string;
 }
 
 export type BetterDocsConfig = {
@@ -39,6 +51,9 @@ export type BetterDocsConfig = {
    * Page Title
    */
   title?: string;
+  /**
+   * Default OgTags
+   */
   ogTags: OgTags;
   /**
    * Component config

diff --git a/src/sections/decorate.ts b/src/sections/decorate.ts
@@ -1,5 +1,6 @@
 import fs from 'fs'
 import path from 'path'
+import { OgTags } from '../better-docs.type'
 
 export const SECTIONS_CONFIG_FILE_NAME = 'sections.json'
 
@@ -16,6 +17,7 @@ export type SectionNav = {
 export type SectionsJSON = {
   [name: string]: {
     title: string;
+    ogTags: OgTags;
   };
 }
 
@@ -54,6 +56,7 @@ export type SectionConfig = {
   title?: string;
   homePath?: string;
   homeBody?: string;
+  ogTags?: OgTags;
 }
 
 /**
@@ -89,14 +92,15 @@ const loadConfig = (sectionConfigPath?: string): Record<string, SectionConfig> |
   return files.filter(file => path.parse(file).ext === '.md').reduce((memo, file) => {
     const name = buildKey(path.parse(file).name)
     const config = jsonConfig[name]
-    const { title } = config || {}
+    const { title, ogTags } = config || {}
     const homePath = path.join(sectionConfigPath, file)
     const homeBody = fs.readFileSync(homePath, 'utf8')
 
     return {
       ...memo,
       [name]: {
         title,
+        ogTags,
         homePath,
         homeBody,
       },
@@ -131,9 +135,13 @@ export function decorateSections(
 
     // on which place should it go to navigation. By default some big number
     let order = 1000 + index
+    let ogTags
 
     if (configSection) {
       href = buildFileName(sectionName)
+      // eslint-disable-next-line prefer-destructuring
+      ogTags = configSection.ogTags
+
       if (configSection.title) {
         ({ title } = configSection)
       }
@@ -149,6 +157,7 @@ export function decorateSections(
         title,
         href,
         order,
+        ogTags,
         homeBody: configSection?.homeBody,
         homePath: configSection?.homePath,
       },