Ass support for group descriptions (#39)

- Collect groupDescriptions in ctx
- Parse groupDescriptions as markdown

src/groupName.js

@@ -4,10 +4,11 @@
  * Compute a `groupName` object from `group` array with slug as key and
  * title as value.
  *
- * Also compute a `groups` property in `ctx`.
+ * Also compute a `groups` and `groupDescriptions` properties in `ctx`.
  */
 module.exports = function groupName (ctx) {
   ctx.groups = ctx.groups || {}
+  ctx.groupDescriptions = ctx.groupDescriptions || {}
 
   // Lowercase the slugs.
   Object.keys(ctx.groups).forEach(function (slug) {
@@ -26,6 +27,7 @@ module.exports = function groupName (ctx) {
         group[slug] = ctx.groups[slug] = slug
       }
     })
+    Object.assign(ctx.groupDescriptions, item.groupDescriptions)
 
     item.groupName = group
   })

src/markdown.js

@@ -81,5 +81,11 @@ module.exports = function markdown (ctx) {
     if ('since' in item) {
       item.since = item.since.map(applyKey(md, 'description'))
     }
+
+    if ('groupDescriptions' in item) {
+      for (let k of Object.keys(item.groupDescriptions)) {
+        item.groupDescriptions[k] = marked(item.groupDescriptions[k])
+      }
+    }
   })
 }

test/fixture/groupName/expected.json

@@ -4,6 +4,10 @@
     "foo": "Foo group",
     "bar": "Bar group"
   },
+  "groupDescriptions": {
+    "foo": "description",
+    "bar": "description"
+  },
   "data": [{
     "description": "Test: function group undefined.\n",
     "context": {
@@ -28,6 +32,9 @@
     "group": [
       "foo"
     ],
+    "groupDescriptions": {
+      "foo": "description"
+    },
     "access": [
       "public"
     ],
@@ -43,6 +50,9 @@
     "group": [
       "bar"
     ],
+    "groupDescriptions": {
+      "bar": "description"
+    },
     "access": [
       "public"
     ],

test/fixture/groupName/input.json

@@ -25,6 +25,9 @@
     "group": [
       "foo"
     ],
+    "groupDescriptions": {
+      "foo": "description"
+    },
     "access": [
       "public"
     ]
@@ -37,6 +40,9 @@
     "group": [
       "bar"
     ],
+    "groupDescriptions": {
+      "bar": "description"
+    },
     "access": [
       "public"
     ]

test/fixture/markdown/expected.json

@@ -34,6 +34,9 @@
     },
     "content": {
       "description": "<p>This should be parsed as Markdown</p>\n"
+    },
+    "groupDescriptions": {
+      "group": "<p>description</p>\n"
     }
   }]
 }

test/fixture/markdown/input.json

@@ -37,6 +37,9 @@
     },
     "content": {
       "description": "This should be parsed as Markdown"
+    },
+    "groupDescriptions": {
+      "group": "description"
     }
   }]
 }