resolves #4 generate page-description on KB articles

Author: ggrossetie

lib/generate-site.js

@@ -22,6 +22,7 @@ async function generateSite (args, env) {
     loadUi(playbook),
   ])
   const pages = convertDocuments(contentCatalog, asciidocConfig)
+  knowledgeBase.generateKnowledgeBasePageDescription(pages)
   knowledgeBase.addCategoryPages(pages, contentCatalog)
   knowledgeBase.addTagPages(pages, contentCatalog)
   const navigationCatalog = buildNavigation(contentCatalog, asciidocConfig)

lib/knowledge-base.js

@@ -1,5 +1,7 @@
 'use strict'
 
+const cheerio = require('cheerio')
+
 // tag::add-category-pages[]
 function addKnowledgeBaseCategoryPages (pages, contentCatalog) {
   const pagesPerCategory = pages
@@ -106,7 +108,44 @@ function createKnowledgeBaseTagPage (tag, pages) {
   }
 }
 
+const generateExcerpt = (page) => {
+  const $ = cheerio.load(page.contents.toString())
+  // removes tables, images and source block
+  $('table').remove()
+  $('img').remove()
+  $('pre').remove()
+  $('iframe').remove()
+  let text = $.text()
+  text = text.trim()
+    .replace(/\n/g, ' ')
+    .replace(/\s{2,}/g, ' ')
+  let words = text.split(' ')
+  let excerpt
+  if (words.length > 30) {
+    words = words.slice(0, 30)
+    excerpt = words.join(' ') + '…'
+  } else {
+    excerpt = words.join(' ')
+  }
+  return excerpt
+}
+
+function generateKnowledgeBasePageDescription(pages) {
+  pages
+    .filter((page) => {
+      return page.src.component === 'kb' &&
+        page.src.basename !== 'index.adoc' &&
+        page.asciidoc &&
+        page.asciidoc.attributes &&
+        !page.asciidoc.attributes['page-description']
+    })
+    .forEach((page) => {
+      page.asciidoc.attributes['page-description'] = generateExcerpt(page)
+    })
+}
+
 module.exports = {
   addCategoryPages: addKnowledgeBaseCategoryPages,
-  addTagPages: addKnowledgeBaseTagPages
+  addTagPages: addKnowledgeBaseTagPages,
+  generateKnowledgeBasePageDescription: generateKnowledgeBasePageDescription
 }