Skip to content

Add support for title substitution with template option enabled. #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zhaofeng-shu33 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add support for title substitution with template option enabled. #26

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9a594e
Add files via upload
zhaofeng-shu33 Dec 30, 2017
76f5f2d
Merge pull request #1 from zhaofeng-shu33/zhaofeng-shu33-patch-1
zhaofeng-shu33 Dec 30, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
366 changes: 184 additions & 182 deletions lib/markdown.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,182 +1,184 @@
'use strict';
// Converts a markdown file into an HTML file, writing it to stdout.
// Implemented as a readable stream.
//
// Usage:
// node format_markdown <filename> <context> <github user id>
//
var marked = require('marked');
var pygmentize = require('pygmentize-bundled');
var linkify = require('../lib/gfm-linkify');
var fs = require('fs');
var path = require('path');
var util = require('util');

var Readable = require('stream').Readable;
util.inherits(Markdown, Readable);

function Markdown() {
this.super_ = this.constructor.super_;
this.super_.call(this);
this.debug = false;
this.bufmax = 1024;
this.html = '';
this.setEncoding('utf8');
}

Markdown.prototype.render = function(fileName, opts, onDone) {
var flavour = opts.flavor || 'gfm',
highlight = opts.highlight,
stylesheet = opts.stylesheet,
context = opts.context,
title = opts.title,
titleText = title,
htmlTemplate = opts.template;

if (title) {
var dirName = path.dirname(fileName),
baseName = path.basename(fileName),
pathName = path.resolve(fileName);
titleText = titleText.replace('$FILENAME', fileName);
titleText = titleText.replace('$DIRNAME', dirName);
titleText = titleText.replace('$BASENAME', baseName);
titleText = titleText.replace('$PATHNAME', pathName);
}

this.done = false;

this.once('error', function(err) {
if (onDone) onDone(err)
else console.error('>>>' + err);
});

if (fileName === null) {
if (onDone) onDone('Missing file name arg');
else console.error('>>>Missing file name arg');
}

//======================================================
// Read the file content.
//======================================================
fs.readFile(fileName, onFileReady.bind(this));

//======================================================
// Process the file content.
//======================================================
function onFileReady(err, data) {
if (err) {
if (onDone) onDone(err);
else console.error('>>>' + err);
return;
}

var fileContent = data.toString();

var options = {
gfm: (flavour === 'gfm') ? true : false,
breaks: true,
tables: true,
sanitize: true
};

if (highlight) {
options['highlight'] = function(code, lang, callback) {
pygmentize({lang: lang, format: 'html'}, code, function(err, result) {
if (err) {
callback(err);
}
callback(err, result.toString());
});
}
}

//======================================================
// Call marked to parse the file content
//======================================================
if (this.debug) console.error('>>>starting to get code');
try {
marked.setOptions(options);
marked(fileContent, getCode.bind(this));
} catch(err) {
if (onDone) onDone(err)
else console.error('>>>' + err);
}

//======================================================
// Enhance the output of marked with optional header
// or trailer. Linkify if context specified.
//======================================================
function getCode(err, code) {
if (err) {
if (onDone) onDone(err)
else console.error('>>>' + err);
return;
}

if (htmlTemplate) {
this.cat(fs.readFileSync(htmlTemplate));

let mdCode = ''
if (context) {
mdCode = linkify(code, context);
} else {
mdCode = code;
}
this.replace(mdCode);
} else {
if (stylesheet || title) {
if (titleText == null) titleText = fileName;
this.cat('<!DOCTYPE html>\n' +
'<html>\n' +
'<head>\n' +
' <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>' +
' <title>' + titleText + '</title>\n');
if (stylesheet) {
this.cat(' <link rel="stylesheet" href="' + stylesheet + '">\n');
}
this.cat('</head>\n<body>\n' );
}

if (context) {
this.cat( linkify(code, context) );
} else {
this.cat( code );
}

if (stylesheet || title) {
this.cat( '</body>\n</html>\n' );
}
}

if (this.debug) console.error('>>>finished getting code');
this.done = true;
if (onDone) onDone();
} // end getCode
} // end onFileReady
} // end render

Markdown.prototype.cat = function(data) {
this.html += data;
}

Markdown.prototype.replace = function(data) {
this.html = this.html.replace('{markdown}', data);
}

Markdown.prototype._read = function(size) {
var pushSize = Math.min(size, this.bufmax);
if (this.html.length > 0) {
if (this.debug) console.error('>>>_read size=' + pushSize + ', html="' + this.html.substr(0, pushSize) + '"');
this.push(this.html.substr(0, pushSize));
this.html = this.html.slice(pushSize);
if (this.done && this.html.length === 0) {
this.push(null); // eof
}
} else {
if (this.debug) console.error('>>>_read - nothing to push');
}
return;
}

module.exports = Markdown;

'use strict';
// Converts a markdown file into an HTML file, writing it to stdout.
// Implemented as a readable stream.
//
// Usage:
// node format_markdown <filename> <context> <github user id>
//
var marked = require('marked');
var pygmentize = require('pygmentize-bundled');
var linkify = require('../lib/gfm-linkify');
var fs = require('fs');
var path = require('path');
var util = require('util');

var Readable = require('stream').Readable;
util.inherits(Markdown, Readable);

function Markdown() {
this.super_ = this.constructor.super_;
this.super_.call(this);
this.debug = false;
this.bufmax = 1024;
this.html = '';
this.setEncoding('utf8');
}

Markdown.prototype.render = function(fileName, opts, onDone) {
var flavour = opts.flavor || 'gfm',
highlight = opts.highlight,
stylesheet = opts.stylesheet,
context = opts.context,
title = opts.title,
titleText = title,
htmlTemplate = opts.template;

if (title) {
var dirName = path.dirname(fileName),
baseName = path.basename(fileName),
pathName = path.resolve(fileName);
titleText = titleText.replace('$FILENAME', fileName);
titleText = titleText.replace('$DIRNAME', dirName);
titleText = titleText.replace('$BASENAME', baseName);
titleText = titleText.replace('$PATHNAME', pathName);
}

this.done = false;

this.once('error', function(err) {
if (onDone) onDone(err)
else console.error('>>>' + err);
});

if (fileName === null) {
if (onDone) onDone('Missing file name arg');
else console.error('>>>Missing file name arg');
}

//======================================================
// Read the file content.
//======================================================
fs.readFile(fileName, onFileReady.bind(this));

//======================================================
// Process the file content.
//======================================================
function onFileReady(err, data) {
if (err) {
if (onDone) onDone(err);
else console.error('>>>' + err);
return;
}

var fileContent = data.toString();

var options = {
gfm: (flavour === 'gfm') ? true : false,
breaks: true,
tables: true,
sanitize: true
};

if (highlight) {
options['highlight'] = function(code, lang, callback) {
pygmentize({lang: lang, format: 'html'}, code, function(err, result) {
if (err) {
callback(err);
}
callback(err, result.toString());
});
}
}

//======================================================
// Call marked to parse the file content
//======================================================
if (this.debug) console.error('>>>starting to get code');
try {
marked.setOptions(options);
marked(fileContent, getCode.bind(this));
} catch(err) {
if (onDone) onDone(err)
else console.error('>>>' + err);
}

//======================================================
// Enhance the output of marked with optional header
// or trailer. Linkify if context specified.
//======================================================
function getCode(err, code) {
if (err) {
if (onDone) onDone(err)
else console.error('>>>' + err);
return;
}

if (htmlTemplate) {
this.cat(fs.readFileSync(htmlTemplate));

let mdCode = ''
if (context) {
mdCode = linkify(code, context);
} else {
mdCode = code;
}
this.replace(mdCode);
if(title){
this.html=this.html.replace('{title}',titleText);
}
} else {
if (stylesheet || title) {
if (titleText == null) titleText = fileName;
this.cat('<!DOCTYPE html>\n' +
'<html>\n' +
'<head>\n' +
' <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>' +
' <title>' + titleText + '</title>\n');
if (stylesheet) {
this.cat(' <link rel="stylesheet" href="' + stylesheet + '">\n');
}
this.cat('</head>\n<body>\n' );
}

if (context) {
this.cat( linkify(code, context) );
} else {
this.cat( code );
}

if (stylesheet || title) {
this.cat( '</body>\n</html>\n' );
}
}

if (this.debug) console.error('>>>finished getting code');
this.done = true;
if (onDone) onDone();
} // end getCode
} // end onFileReady
} // end render

Markdown.prototype.cat = function(data) {
this.html += data;
}

Markdown.prototype.replace = function(data) {
this.html = this.html.replace('{markdown}', data);
}

Markdown.prototype._read = function(size) {
var pushSize = Math.min(size, this.bufmax);
if (this.html.length > 0) {
if (this.debug) console.error('>>>_read size=' + pushSize + ', html="' + this.html.substr(0, pushSize) + '"');
this.push(this.html.substr(0, pushSize));
this.html = this.html.slice(pushSize);
if (this.done && this.html.length === 0) {
this.push(null); // eof
}
} else {
if (this.debug) console.error('>>>_read - nothing to push');
}
return;
}

module.exports = Markdown;