feature: terminull as a markdown

Author: ridaeh

assets/terminull.css

@@ -20,8 +20,8 @@
   color: white;
   text-align: left;
   font-family: monospace;
-  overflow: hidden;
-  word-wrap:break-word;
+  white-space: nowrap;
+  overflow-y: auto;
 }
 
 .terminullComment {
@@ -61,7 +61,12 @@
 
 .terminullOutput {
   display: block;
+  white-space: pre-line;
 }
 
-.terminullCopyBtn { transition: all .2s ease-in-out; }
-.terminullCopyBtn:hover { transform: scale(1.1); }
+.terminullCopyBtn {
+  transition: all 0.2s ease-in-out;
+}
+.terminullCopyBtn:hover {
+  transform: scale(1.1);
+}

index.js

@@ -1,25 +1,71 @@
 var ejs = require('ejs');
 const path = require('path');
+const kramed = require('./src/kramed');
 
 function processBlock(rootBlock) {
   var terminulls = [];
-  var term = {}
+  var term = {};
   rootBlock.blocks.forEach(_blk => {
-    if(term[_blk.name]){
-      terminulls.push(term)
-      term = {}
-    } 
+    if (term[_blk.name]) {
+      terminulls.push(term);
+      term = {};
+    }
     term[_blk.name] = _blk.body.trim();
   });
-  terminulls.push(term)
-  return new Promise(function(resolve, reject){
-           ejs.renderFile(path.join(__dirname, './src/terminull.html.ejs'),{terminulls:terminulls},function(err, str){
-             if(err) {
-               throw err
-             }
-             resolve(str)
-           })
-        })
+  terminulls.push(term);
+  return new Promise(function(resolve, reject) {
+    ejs.renderFile(
+      path.join(__dirname, './src/terminull.html.ejs'),
+      { terminulls: terminulls },
+      function(err, str) {
+        if (err) {
+          throw err;
+        }
+        resolve(str);
+      }
+    );
+  });
+}
+
+function terminullBlock(text) {
+  var contexts = [];
+  var context = {};
+  var lines = text.split('\n');
+  lines.forEach(function(line) {
+    if (line.indexOf('$') > -1 || lines.length == 1) {
+      if (context.command) {
+        contexts.push(context);
+      }
+      context = {};
+      var command = line;
+      if (line.indexOf('$') > -1) {
+        context.directory = line.substring(0, line.indexOf('$')) || '';
+        command = line.substring(line.indexOf('$') + 1, line.length);
+      }
+      context.command = command.split('#')[0];
+      context.comment = command.split('#')[1] ? command.split('#')[1] : '';
+    } else {
+      context.output = context.output ? context.output + '\n' + line : line;
+    }
+  });
+  contexts.push(context);
+  var blocks = contexts.map(function(context) {
+    return (
+      `{% directory %}${context.directory || ''}{% command %}${
+        context.command
+      }{% comment %}${context.comment || ''}` +
+      `{% output %} ${context.output || ''}`
+    );
+  });
+  return '{% term %}' + [...blocks].join('\n') + '{% endterm %}';
+}
+
+function markdown2Tag(text) {
+  var blockCode = terminullBlock(text);
+  return {
+    type: 'paragraph',
+    text: blockCode
+  };
 }
 
 module.exports = {
@@ -30,8 +76,22 @@ module.exports = {
   },
   blocks: {
     term: {
-      blocks: ['directory', 'command','comment', 'output'],
+      blocks: ['directory', 'command', 'comment', 'output'],
       process: processBlock
     }
+  },
+  hooks: {
+    'page:before': function(page) {
+      if (page.type == 'markdown') {
+        var lexed = kramed.lexer(page.content);
+        lexed.forEach(function(section, index) {
+          if (section.type === 'code' && section.lang === 'term') {
+            lexed[index] = markdown2Tag(section.text);
+          }
+        });
+        page.content = kramed.render(lexed);
+      }
+      return page;
+    }
   }
 };

package.json

@@ -23,6 +23,8 @@
     "gitbook": ">2.5.0"
   },
   "dependencies": {
-    "ejs": "^3.0.1"
+    "ejs": "^3.0.1",
+    "kramed": "^0.5.6",
+    "kramed-markdown-renderer": "^0.1.2"
   }
 }

src/kramed.js

@@ -0,0 +1,20 @@
+var kramed = require('kramed');
+var renderer = require('kramed-markdown-renderer');
+
+function render(lexed) {
+  var options = Object.create(kramed.defaults);
+  options.escape = false;
+  options.renderer = renderer();
+  return kramed.parser(lexed, options);
+}
+
+function lexer(content) {
+  var options = Object.create(kramed.defaults);
+  options.escape = false;
+  return kramed.lexer(content, options);
+}
+
+module.exports = {
+  render: render,
+  lexer: lexer
+};