Adapt for gitbook-html@1.1.0

4 files changed, 54 insertions, 10 deletions

diff --git a/packages/gitbook-markdown/lib/index.js b/packages/gitbook-markdown/lib/index.js
index 1f575a5..49edee6 100644
--- a/packages/gitbook-markdown/lib/index.js
+++ b/packages/gitbook-markdown/lib/index.js
@@ -1,8 +1,10 @@
-var htmlParser = require('gitbook-html');
+var HTMLParser = require('gitbook-html');
 
 var toHTML = require('./tohtml');
-var toMarkdown = require('./tomarkdown');
+var toMarkdown = require('./toMarkdown');
 var page = require('./page');
 
-module.exports = htmlParser.createParser(toHTML, toMarkdown);
+module.exports = HTMLParser.createParser(toHTML, toMarkdown);
+
+// Add the custom page escaping
 module.exports.page.prepare = page.prepare;
diff --git a/packages/gitbook-markdown/lib/page.js b/packages/gitbook-markdown/lib/page.js
index bdb359e..5bb842e 100644
--- a/packages/gitbook-markdown/lib/page.js
+++ b/packages/gitbook-markdown/lib/page.js
@@ -5,17 +5,33 @@ var annotate = require('kramed/lib/annotate/');
 var RAW_START = '{% raw %}';
 var RAW_END = '{% endraw %}';
 
-// Escape a code block using raw blocks
+/**
+    Escape a code block's content using raw blocks
+
+    @param {String}
+    @return {String}
+*/
 function escape(str) {
     return RAW_START + str + RAW_END;
 }
 
-// Combines annotated nodes
+/**
+    Combines annotated nodes
+
+    @param {Array}
+    @return {String}
+*/
 function combine(nodes) {
     return _.pluck(nodes, 'raw').join('');
 }
 
-// Add templating "raw" to code blocks
+/**
+    Add templating "raw" to code blocks to
+    avoid nunjucks processing their content.
+
+    @param {String} src
+    @return {String}
+*/
 function preparePage(src) {
     var lexed = annotate.blocks(src);
     var levelRaw = 0;
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());
 }
diff --git a/packages/gitbook-markdown/lib/tomarkdown.js b/packages/gitbook-markdown/lib/tomarkdown.js
index 5bee4e0..aab642c 100644
--- a/packages/gitbook-markdown/lib/tomarkdown.js
+++ b/packages/gitbook-markdown/lib/tomarkdown.js
@@ -4,6 +4,10 @@ function ns(s, n) {
     return Array(n + 1).join(s);
 }
 
+/*
+    This module provides markup rules for gitbook-html
+    These rules are being used to generate SUMMARY/GLOSSARY/LANGS
+*/
 module.exports = {
     onTitleStart: function(level) {
         return ns('#', level) + ' ';
@@ -39,5 +43,9 @@ module.exports = {
     onListItemEnd: function() {
         return '';
     },
+
+    onHR: function() {
+        return '-----';
+    }
 };