diff options
| -rw-r--r-- | README.md | 1 | ||||
| -rw-r--r-- | lib/generate/index.js | 30 | ||||
| -rw-r--r-- | lib/parse/code_include.js | 20 | ||||
| -rw-r--r-- | lib/parse/page.js | 12 | ||||
| -rw-r--r-- | lib/parse/renderer.js | 15 | ||||
| -rw-r--r-- | test/fixtures/INCLUDES.md | 29 | ||||
| -rw-r--r-- | test/fixtures/included.c | 7 | ||||
| -rw-r--r-- | test/includes.js | 38 | ||||
| -rw-r--r-- | theme/templates/includes/book/summary.html | 2 |
9 files changed, 142 insertions, 12 deletions
@@ -258,6 +258,7 @@ Plugins can used to extend your book's functionality. Read [GitbookIO/plugin](ht * [Markdown within HTML](https://github.com/mrpotes/gitbook-plugin-nestedmd): Process markdown within HTML blocks - allows custom layout options for individual pages * [Bootstrap JavaScript plugins](https://github.com/mrpotes/gitbook-plugin-bootstrapjs): Use the [Bootstrap JavaScript plugins](http://getbootstrap.com/javascript) in your online GitBook * [Piwik Open Analytics](https://github.com/emmanuel-keller/gitbook-plugin-piwik): Piwik Open Analytics tracking for your book +* [Heading Anchors](https://github.com/rlmv/gitbook-plugin-anchors): Add linkable Github-style anchors to headings #### Debugging 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/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/page.js b/lib/parse/page.js index 6cfd3ca..d714a15 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; @@ -74,15 +75,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/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/test/fixtures/INCLUDES.md b/test/fixtures/INCLUDES.md new file mode 100644 index 0000000..22e3a61 --- /dev/null +++ b/test/fixtures/INCLUDES.md @@ -0,0 +1,29 @@ +# Beautiful chapter + +Here is a nice included snippet : + +```c +{{ included.c }} +``` + +---- + +An exercise using includes + +```c +{{ included.c }} + +Remove this extra code at the end +``` + +```c +{{ included.c }} +``` + +```c +{{ included.c }} + +This validation code is wrong but who cares ? +``` + +---- diff --git a/test/fixtures/included.c b/test/fixtures/included.c new file mode 100644 index 0000000..d9323e3 --- /dev/null +++ b/test/fixtures/included.c @@ -0,0 +1,7 @@ +#include <stdio.h> + +int main(int argc, char *argv[]) { + printf("All is well\n"); + + return 0; +} diff --git a/test/includes.js b/test/includes.js new file mode 100644 index 0000000..69adc11 --- /dev/null +++ b/test/includes.js @@ -0,0 +1,38 @@ +var fs = require('fs'); +var path = require('path'); +var assert = require('assert'); + +var page = require('../').parse.page; + +var FIXTURES_DIR = path.join(__dirname, './fixtures/'); + +function loadPage (name, options) { + var CONTENT = fs.readFileSync(FIXTURES_DIR + name + '.md', 'utf8'); + return page(CONTENT, options); +} + + +describe('Code includes', function() { + + var LEXED = loadPage('INCLUDES', { + 'dir': FIXTURES_DIR, + }); + + var INCLUDED_C = fs.readFileSync(path.join(FIXTURES_DIR, 'included.c'), 'utf8'); + + it('should work for snippets', function() { + assert.equal(LEXED[0].type, 'normal'); + // Has replaced include + assert.equal( + LEXED[0].content.indexOf('{{ included.c }}'), + -1 + ); + }); + + it('should work for exercises', function() { + assert.equal(LEXED[1].type, 'exercise'); + + // Solution is trimmed version of source + assert.equal(LEXED[1].code.solution, INCLUDED_C.trim()); + }); +}); diff --git a/theme/templates/includes/book/summary.html b/theme/templates/includes/book/summary.html index a177edf..8014d7e 100644 --- a/theme/templates/includes/book/summary.html +++ b/theme/templates/includes/book/summary.html @@ -1,7 +1,7 @@ {% macro articles(_articles) %} {% for item in _articles %} {% set externalLink = item.path|isExternalLink %} - <li class="chapter {% if item._path == _input %}active{% endif %}" data-level="{{ item.level }}" {% if item.path && !externalLink %}data-path="{{ item.path|mdLink }}"{% endif %}> + <li class="chapter {% if item.path == _input %}active{% endif %}" data-level="{{ item.level }}" {% if item.path && !externalLink %}data-path="{{ item.path|mdLink }}"{% endif %}> {% if item.path %} {% if !externalLink %} <a href="{{ basePath }}/{{ item.path|mdLink }}"> |