summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
Diffstat (limited to 'lib')
-rw-r--r--lib/generate/index.js30
-rw-r--r--lib/generate/site/index.js1
-rw-r--r--lib/parse/code_include.js20
-rw-r--r--lib/parse/langs.js14
-rw-r--r--lib/parse/page.js12
-rw-r--r--lib/parse/progress.js3
-rw-r--r--lib/parse/renderer.js15
-rw-r--r--lib/parse/summary.js32
-rw-r--r--lib/utils/lang.js1
-rw-r--r--lib/utils/links.js14
10 files changed, 108 insertions, 34 deletions
diff --git a/lib/generate/index.js b/lib/generate/index.js
index 444f75f..53de646 100644
--- a/lib/generate/index.js
+++ b/lib/generate/index.js
@@ -271,13 +271,31 @@ var generateBook = function(options) {
// Get summary
.then(function() {
- return fs.readFile(path.join(options.input, "SUMMARY.md"), "utf-8")
- .then(function(_summary) {
- options.summary = parse.summary(_summary);
+ var summary = {
+ path: path.join(options.input, "SUMMARY.md")
+ };
- // Parse navigation
- options.navigation = parse.navigation(options.summary);
- });
+ var _callHook = function(name) {
+ return generator.callHook(name, summary)
+ .then(function(_summary) {
+ summary = _summary;
+ return summary;
+ });
+ };
+
+ return fs.readFile(summary.path, "utf-8")
+ .then(function(_content) {
+ summary.content = _content;
+ return _callHook("summary:before");
+ })
+ .then(function() {
+ summary.content = parse.summary(summary.content);
+ return _callHook("summary:after");
+ })
+ .then(function() {
+ options.summary = summary.content;
+ options.navigation = parse.navigation(options.summary);
+ })
})
// Skip processing some files
diff --git a/lib/generate/site/index.js b/lib/generate/site/index.js
index b59c01c..dcc48d7 100644
--- a/lib/generate/site/index.js
+++ b/lib/generate/site/index.js
@@ -102,6 +102,7 @@ Generator.prototype.convertFile = function(content, _input) {
var page = {
path: _input,
+ rawPath: input, // path to raw md file
content: content,
progress: parse.progress(this.options.navigation, _input)
};
diff --git a/lib/parse/code_include.js b/lib/parse/code_include.js
new file mode 100644
index 0000000..f4656f1
--- /dev/null
+++ b/lib/parse/code_include.js
@@ -0,0 +1,20 @@
+var fs = require('fs');
+var path = require('path');
+
+module.exports = function(code, folder) {
+ folder = folder || '';
+
+ return code.replace(/{{([\s\S]+?)}}/g, function(match, filename) {
+ // Normalize filename
+ var fname = path.join(folder, filename.trim());
+
+ // Try including snippet from FS
+ try {
+ // Trim trailing newlines/space of imported snippets
+ return fs.readFileSync(fname, 'utf8').trimRight();
+ } catch(err) {}
+
+ // If fails leave content as is
+ return match;
+ });
+};
diff --git a/lib/parse/langs.js b/lib/parse/langs.js
index 46c3a46..01b7c8c 100644
--- a/lib/parse/langs.js
+++ b/lib/parse/langs.js
@@ -1,13 +1,14 @@
-var _ = require("lodash")
-var parseSummary = require("./summary");
+var _ = require("lodash");
+var parseEntries = require("./summary").entries;
+
var parseLangs = function(content) {
- var summary = parseSummary(content);
+ var entries = parseEntries(content);
return {
- list: _.chain(summary.chapters)
+ list: _.chain(entries)
.filter(function(entry) {
- return entry.path != null;
+ return Boolean(entry.path);
})
.map(function(entry) {
return {
@@ -17,7 +18,8 @@ var parseLangs = function(content) {
};
})
.value()
- }
+ };
};
+
module.exports = parseLangs; \ No newline at end of file
diff --git a/lib/parse/page.js b/lib/parse/page.js
index 2db4476..b459798 100644
--- a/lib/parse/page.js
+++ b/lib/parse/page.js
@@ -5,6 +5,7 @@ var hljs = require('highlight.js');
var lex = require('./lex');
var renderer = require('./renderer');
+var codeInclude = require('./code_include');
var lnormalize = require('../utils/lang').normalize;
@@ -73,15 +74,20 @@ function parsePage(src, options) {
// Main language
var lang = validLangs ? langs[0] : null;
+ // codeInclude shortcut
+ var ci = function(code) {
+ return codeInclude(code, options.dir);
+ };
+
return {
id: section.id,
type: section.type,
content: render(nonCodeNodes),
lang: lang,
code: {
- base: codeNodes[0].text,
- solution: codeNodes[1].text,
- validation: codeNodes[2].text,
+ base: ci(codeNodes[0].text),
+ solution: ci(codeNodes[1].text),
+ validation: ci(codeNodes[2].text),
// Context is optional
context: codeNodes[3] ? codeNodes[3].text : null,
}
diff --git a/lib/parse/progress.js b/lib/parse/progress.js
index 0abdf8d..10a06d2 100644
--- a/lib/parse/progress.js
+++ b/lib/parse/progress.js
@@ -11,9 +11,6 @@ var calculProgress = function(navigation, current) {
nav.path = path;
return nav;
})
- .sortBy(function(nav) {
- return parseFloat(nav.level);
- })
.map(function(nav, i) {
// Calcul percent
nav.percent = (i * 100) / Math.max((n - 1), 1);
diff --git a/lib/parse/renderer.js b/lib/parse/renderer.js
index 4da312e..dcbc261 100644
--- a/lib/parse/renderer.js
+++ b/lib/parse/renderer.js
@@ -1,6 +1,7 @@
var url = require('url');
var inherits = require('util').inherits;
var links = require('../utils').links;
+var codeInclude = require('./code_include');
var path = require('path');
@@ -56,7 +57,7 @@ GitBookRenderer.prototype.link = function(href, title, text) {
// Relative link, rewrite it to point to github repo
if(links.isRelative(_href)) {
- if (path.extname(_href) == ".md") {
+ if (path.extname(parsed.path) == ".md") {
_href = links.toAbsolute(_href, o.dir || "./", o.outdir || "./");
if (o.singleFile) {
@@ -125,7 +126,7 @@ GitBookRenderer.prototype._createCheckboxAndRadios = function(text) {
var length = splittedText.length;
var label = '<label class="quiz-label" for="' + quizIdentifier + '">' + splittedText[length - 1] + '</label>';
return text.replace(fieldRegex, field).replace(splittedText[length - 1], label);
-}
+};
GitBookRenderer.prototype.tablecell = function(content, flags) {
return GitBookRenderer.super_.prototype.tablecell(this._createCheckboxAndRadios(content), flags);
@@ -135,5 +136,15 @@ GitBookRenderer.prototype.listitem = function(text) {
return GitBookRenderer.super_.prototype.listitem(this._createCheckboxAndRadios(text));
};
+GitBookRenderer.prototype.code = function(code, lang, escaped) {
+ return GitBookRenderer.super_.prototype.code.call(
+ this,
+ // Import code snippets
+ codeInclude(code, this._extra_options.dir),
+ lang,
+ escaped
+ );
+};
+
// Exports
module.exports = GitBookRenderer;
diff --git a/lib/parse/summary.js b/lib/parse/summary.js
index 7e54df0..fd300bc 100644
--- a/lib/parse/summary.js
+++ b/lib/parse/summary.js
@@ -87,6 +87,9 @@ function parseTitle(src, nums) {
}
function parseChapter(nodes, nums) {
+ // Convert single number to an array
+ nums = _.isArray(nums) ? nums : [nums];
+
return _.extend(parseTitle(_.first(nodes).text, nums), {
articles: _.map(listSplit(filterList(nodes), 'list_item_start', 'list_item_end'), function(nodes, i) {
return parseChapter(nodes, nums.concat(i + 1));
@@ -97,11 +100,13 @@ function parseChapter(nodes, nums) {
function defaultChapterList(chapterList) {
var first = _.first(chapterList);
- var chapter = parseChapter(first, [0]);
+ if (first) {
+ var chapter = parseChapter(first, [0]);
- // Already have README node, we're good to go
- if(chapter.path === 'README.md') {
- return chapterList;
+ // Already have README node, we're good to go
+ if(chapter.path === 'README.md') {
+ return chapterList;
+ }
}
return [
@@ -109,26 +114,31 @@ function defaultChapterList(chapterList) {
].concat(chapterList);
}
-function parseSummary(src) {
+function listGroups(src) {
var nodes = marked.lexer(src);
- // Get out list of chapters
- var chapterList = listSplit(
+ // Get out groups of lists
+ return listSplit(
filterList(nodes),
'list_item_start', 'list_item_end'
);
+}
+function parseSummary(src) {
// Split out chapter sections
- var chapters = defaultChapterList(chapterList)
- .map(function(nodes, i) {
- return parseChapter(nodes, [i]);
- });
+ var chapters = defaultChapterList(listGroups(src))
+ .map(parseChapter);
return {
chapters: chapters
};
}
+function parseEntries (src) {
+ return listGroups(src).map(parseChapter);
+}
+
// Exports
module.exports = parseSummary;
+module.exports.entries = parseEntries;
diff --git a/lib/utils/lang.js b/lib/utils/lang.js
index 9eabbb5..9da737b 100644
--- a/lib/utils/lang.js
+++ b/lib/utils/lang.js
@@ -2,6 +2,7 @@ var MAP = {
'py': 'python',
'js': 'javascript',
'rb': 'ruby',
+ 'csharp': 'cs',
};
function normalize(lang) {
diff --git a/lib/utils/links.js b/lib/utils/links.js
index 6606bbf..b4d2fb7 100644
--- a/lib/utils/links.js
+++ b/lib/utils/links.js
@@ -3,14 +3,22 @@ var path = require('path');
// Is the link an external link
var isExternal = function(href) {
- return Boolean(url.parse(href).protocol);
+ try {
+ return Boolean(url.parse(href).protocol);
+ } catch(err) { }
+
+ return false;
};
// Return true if the link is relative
var isRelative = function(href) {
- var parsed = url.parse(href);
+ try {
+ var parsed = url.parse(href);
+
+ return !parsed.protocol && parsed.path && parsed.path[0] != '/';
+ } catch(err) {}
- return !parsed.protocol && parsed.path && parsed.path[0] != '/';
+ return true;
};
// Relative to absolute path
generated by cgit v1.1 at 2025-05-21 20:52:07 +0000