Adapt for gitbook-html@1.1.0

1 files changed, 22 insertions, 4 deletions

diff --git a/packages/gitbook-markdown/lib/tohtml.js b/packages/gitbook-markdown/lib/tohtml.js
index 628ebce..c40c545 100644
--- a/packages/gitbook-markdown/lib/tohtml.js
+++ b/packages/gitbook-markdown/lib/tohtml.js
@@ -1,7 +1,11 @@
 var _ = require('lodash');
 var kramed = require('kramed');
 
-// Get renderer for kramed
+/**
+    Get renderer for kramed with correct configuration
+
+    @return {kramed.Renderer}
+*/
 function getRenderer() {
     return new kramed.Renderer({
         langPrefix: 'lang-',
@@ -12,14 +16,23 @@ function getRenderer() {
     });
 }
 
-// Get options for markdown parsing
+/**
+    Get options for markdown parsing
+
+    @return {Object}
+*/
 function getOption() {
     return _.extend({}, kramed.defaults, {
         mathjax: false
     });
 }
 
-// Convert Markdown to HTML
+/**
+    Convert Markdown block to HTML
+
+    @param {String} src (markdown)
+    @return {String} (html)
+*/
 function convertMdToHTMLBlock(src) {
     var options = _.extend(getOption(), {
         renderer: getRenderer()
@@ -28,7 +41,12 @@ function convertMdToHTMLBlock(src) {
     return kramed(src, options);
 }
 
-// Convert Markdown to HTML (inline)
+/**
+    Convert Markdown inline to HTML
+
+    @param {String} src (markdown)
+    @return {String} (html)
+*/
 function convertMdToHTMLInline(src) {
     return kramed.inlineLexer(src, getOption(), getRenderer());
 }