├── .gitignore ├── LICENSE ├── README.md ├── assets ├── ebook_quiz.html ├── quizzes.css ├── quizzes.js └── website_quiz.html ├── index.js ├── lib ├── block.js ├── is_quiz.js ├── renderer.js ├── retro.js ├── section2obj.js └── sections.js └── package.json /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | 5 | # Runtime data 6 | pids 7 | *.pid 8 | *.seed 9 | 10 | # Directory for instrumented libs generated by jscoverage/JSCover 11 | lib-cov 12 | 13 | # Coverage directory used by tools like istanbul 14 | coverage 15 | 16 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 17 | .grunt 18 | 19 | # Compiled binary addons (http://nodejs.org/api/addons.html) 20 | build/Release 21 | 22 | # Dependency directory 23 | # Deployed apps should consider commenting this line out: 24 | # see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git 25 | node_modules 26 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Interactive quizzes in a gitbook 2 | ============== 3 | 4 | With this plugin, a book can contain interactive quizzes. 5 | 6 | 7 | ## How to use it? 8 | 9 | This plugin is installed by default with gitbook 1.0.1. 10 | 11 | To use the quizzes plugin in your Gitbook project, add the `quizzes` plugin to the `book.json` file. 12 | 13 | ``` 14 | { 15 | "plugins": ["quizzes"] 16 | } 17 | ``` 18 | 19 | > If you want to use multiple plugins in your project, seperate the plugin names with a comma. For example: `"plugins": ["quizzes", "exercises"]`. 20 | 21 | 22 | ## Quizzes format 23 | 24 | Quizzes need to start and finish with a separation bar (```---``` or ```***```). 25 | 26 | --- 27 | 28 | Here's a quiz about Gitbook 29 | 30 | | | Good | Bad | 31 | | ---------------- | ---- | --- | 32 | | What is Gitbook? | (x) | ( ) | 33 | 34 | > Gitbook is good 35 | 36 | What does Gitbook support? 37 | - [x] Table-based questions with radio buttons 38 | - [x] Table-based questions with checkboxes 39 | - [ ] Telepathy 40 | - [x] List-based questions with checkboxes 41 | - [x] List-based questions with radio buttons 42 | - [ ] Moon-on-a-stick 43 | 44 | > Gitbook supports table and list based quiz questions using either radio buttons or checkboxes. 45 | > 46 | > Gitbook is not telepathic and does not give you the moon on a stick. 47 | 48 | --- 49 | 50 | -------------------------------------------------------------------------------- /assets/ebook_quiz.html: -------------------------------------------------------------------------------- 1 |
2 | 3 |
Quiz
4 |
<%= quiz.content %>
5 | <% quiz.questions.forEach(function(question, idx) { %> 6 |
7 |
Question <%= idx+1 %> of <%= quiz.questions.length %>
8 | 9 |
10 | <%= question.base %> 11 |
12 |
13 | <%= question.solution %> 14 |
15 |
16 | <% }) %> 17 | 18 |
19 | -------------------------------------------------------------------------------- /assets/quizzes.css: -------------------------------------------------------------------------------- 1 | .book .book-body .page-wrapper .page-inner section.quiz { 2 | display: block !important; 3 | padding: 0px; 4 | margin: 20px 15px; 5 | border: 3px solid #2f8cde; 6 | background: #fff; 7 | color: #333; 8 | font-family: sans-serif; 9 | } 10 | 11 | .page-inner section.quiz .header { 12 | padding: 5px 15px; 13 | color: #fff; 14 | background: #2f8cde; 15 | } 16 | 17 | .page-inner section.quiz .header h2 { 18 | margin: 0px; 19 | font-size: 20px; 20 | } 21 | 22 | .page-inner section.quiz .message { 23 | margin: 15px; 24 | } 25 | 26 | .page-inner section.quiz .question .question-header { 27 | padding: 5px 15px; 28 | color: #fff; 29 | background: #2f8cde; 30 | } 31 | 32 | .page-inner section.quiz .question .question-inner { 33 | padding: 15px; 34 | } 35 | 36 | .page-inner section.quiz .question .question-inner .quiz-label { 37 | font-weight: normal; 38 | cursor: pointer; 39 | } 40 | 41 | .page-inner section.quiz .question table { 42 | margin-bottom: 10px; 43 | width: 100%; 44 | } 45 | 46 | .page-inner section.quiz .question th, 47 | .page-inner section.quiz .question td { 48 | padding-right: 5px; 49 | } 50 | 51 | .page-inner section.quiz .question li { 52 | list-style-type: none; 53 | } 54 | 55 | .page-inner section.quiz .question li input { 56 | margin-right: 10px; 57 | } 58 | -------------------------------------------------------------------------------- /assets/quizzes.js: -------------------------------------------------------------------------------- 1 | require(["gitbook"], function(gitbook) { 2 | // Bind a quiz 3 | var prepareQuiz = function($quiz) { 4 | 5 | $quiz.find(".quiz-answers input").click(function(e) { 6 | e.preventDefault(); 7 | }); 8 | 9 | // Submit: test code 10 | $quiz.find(".action-submit").click(function(e) { 11 | e.preventDefault(); 12 | gitbook.events.trigger("exercise.submit", {type: "quiz"}); 13 | $quiz.find("tr.alert-danger,li.alert-danger").removeClass("alert-danger"); 14 | $quiz.find(".alert-success,.alert-danger").addClass("hidden"); 15 | 16 | $quiz.find(".question").each(function(q) { 17 | var result = true; 18 | 19 | var $questions = $(this).find(".question-content").find("input[type=radio], input[type=checkbox]"); 20 | var $answers = $(this).find(".question-answers").find("input[type=radio], input[type=checkbox]"); 21 | 22 | $questions.each(function(i) { 23 | var correct = $(this).is(":checked") === $answers.slice(i).first().is(":checked"); 24 | result = result && correct; 25 | if (!correct) { 26 | $(this).closest("tr, li").addClass("alert-danger"); 27 | } 28 | }); 29 | $(this).find(result ? "div.alert-success" : "div.alert-danger").toggleClass("hidden"); 30 | }); 31 | 32 | }); 33 | 34 | $quiz.find(".action-solution").click(function(e) { 35 | e.preventDefault(); 36 | $quiz.find(".question-content, .question-answers").toggleClass("hidden"); 37 | }); 38 | }; 39 | 40 | // Prepare all exercise 41 | var init = function() { 42 | gitbook.state.$book.find("section.quiz").each(function() { 43 | prepareQuiz($(this)); 44 | }); 45 | }; 46 | 47 | gitbook.events.bind("page.change", function() { 48 | init(); 49 | }); 50 | }); -------------------------------------------------------------------------------- /assets/website_quiz.html: -------------------------------------------------------------------------------- 1 |
2 | 3 |
4 |

Quiz

5 |
6 | 7 |
8 | <%= quiz.content %> 9 |
10 | 11 | 12 | <% quiz.questions.forEach(function(question, idx) { %> 13 |
14 |
Question <%= idx+1 %> of <%= quiz.questions.length %>
15 | 16 |
17 | 20 | 21 | 25 | 26 |
27 | <%= question.base %> 28 |
29 |
30 | 31 | 36 |
37 | <% }) %> 38 | 39 |
40 | Submit 41 | Solution 42 |
43 | 44 |
45 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | var _ = require("lodash"); 2 | var fs = require("fs"); 3 | var path = require("path"); 4 | 5 | var retro = require("./lib/retro"); 6 | var block = require("./lib/block"); 7 | 8 | var QUIZ_WEBSITE_TPL = _.template(fs.readFileSync(path.resolve(__dirname, "./assets/website_quiz.html"))); 9 | var QUIZ_EBOOK_TPL = _.template(fs.readFileSync(path.resolve(__dirname, "./assets/ebook_quiz.html"))); 10 | 11 | module.exports = { 12 | website: { 13 | assets: "./assets", 14 | js: [ 15 | "quizzes.js", 16 | ], 17 | css: [ 18 | "quizzes.css" 19 | ], 20 | }, 21 | blocks: { 22 | quiz: { 23 | process: function(blk) { 24 | // Extract quiz info 25 | var context = block(blk.body); 26 | 27 | // Select appropriate template 28 | var tpl = (this.generator === 'ebook' ? QUIZ_EBOOK_TPL : QUIZ_WEBSITE_TPL); 29 | 30 | return tpl({ 31 | quiz: context 32 | }); 33 | } 34 | } 35 | }, 36 | hooks: { 37 | "page:before": function(page) { 38 | // Skip all non markdown pages 39 | if(page.type != "markdown") { 40 | return page; 41 | } 42 | 43 | // Rewrite content (modernizing old exercises) 44 | page.content = retro(page.content); 45 | 46 | // Return modified page 47 | return page; 48 | } 49 | } 50 | }; 51 | -------------------------------------------------------------------------------- /lib/block.js: -------------------------------------------------------------------------------- 1 | var kramed = require('kramed'); 2 | 3 | var section2obj = require('./section2obj'); 4 | 5 | // Turn a section into a parsed quiz 6 | function block(blockText) { 7 | var lexed = kramed.lexer(blockText); 8 | 9 | return section2obj(lexed); 10 | } 11 | 12 | module.exports = block; 13 | -------------------------------------------------------------------------------- /lib/is_quiz.js: -------------------------------------------------------------------------------- 1 | var _ = require('lodash'); 2 | 3 | function isQuizNode(node) { 4 | return (/^[(\[][ x][)\]]/).test(node.text || node); 5 | } 6 | 7 | function isTableQuestion(nodes) { 8 | var block = questionBlock(nodes); 9 | return ( 10 | block.length === 1 && 11 | block[0].type === 'table' && 12 | _.all(block[0].cells[0].slice(1), isQuizNode) 13 | ); 14 | } 15 | 16 | function isListQuestion(nodes) { 17 | var block = questionBlock(nodes); 18 | // Counter of when we go in and out of lists 19 | var inlist = 0; 20 | // Number of lists we found 21 | var lists = 0; 22 | // Elements found outside a list 23 | var outsiders = 0; 24 | // Ensure that we have nothing except lists 25 | _.each(block, function(node) { 26 | if(node.type === 'list_start') { 27 | inlist++; 28 | } else if(node.type === 'list_end') { 29 | inlist--; 30 | lists++; 31 | } else if(inlist === 0) { 32 | // Found non list_start or list_end whilst outside a list 33 | outsiders++; 34 | } 35 | }); 36 | return lists > 0 && outsiders === 0; 37 | } 38 | 39 | function isQuestion(nodes) { 40 | return isListQuestion(nodes) || isTableQuestion(nodes); 41 | } 42 | 43 | // Remove (optional) paragraph header node and blockquote 44 | function questionBlock(nodes) { 45 | return nodes.slice( 46 | nodes[0].type === 'paragraph' ? 1 : 0, 47 | _.findIndex(nodes, { type: 'blockquote_start' }) 48 | ); 49 | } 50 | 51 | function splitQuestions(nodes) { 52 | // Represents nodes in current question 53 | var buffer = []; 54 | return _.reduce(nodes, function(accu, node) { 55 | // Add node to buffer 56 | buffer.push(node); 57 | 58 | // Flush buffer once we hit the end of a question 59 | if(node.type === 'blockquote_end') { 60 | accu.push(buffer); 61 | // Clear buffer 62 | buffer = []; 63 | } 64 | 65 | return accu; 66 | }, []); 67 | } 68 | 69 | function isQuiz(nodes) { 70 | // Extract potential questions 71 | var questions = splitQuestions( 72 | // Skip quiz title if there 73 | nodes.slice( 74 | (nodes[0] && nodes[0].type) === 'paragraph' ? 1 : 0 75 | ) 76 | ); 77 | 78 | // Nothing that looks like questions 79 | if(questions.length === 0) { 80 | return false; 81 | } 82 | 83 | // Ensure all questions are correctly structured 84 | return _.all(questions, isQuestion); 85 | } 86 | 87 | module.exports = isQuiz; 88 | -------------------------------------------------------------------------------- /lib/renderer.js: -------------------------------------------------------------------------------- 1 | var inherits = require('util').inherits; 2 | var kramed = require('kramed'); 3 | 4 | var rendererId = 0; 5 | 6 | function QuizRenderer(options, extra_options) { 7 | if(!(this instanceof QuizRenderer)) { 8 | return new QuizRenderer(options, extra_options); 9 | } 10 | QuizRenderer.super_.call(this, options); 11 | 12 | this._extra_options = extra_options; 13 | this.quizRowId = 0; 14 | this.id = rendererId++; 15 | this.quizIndex = 0; 16 | } 17 | inherits(QuizRenderer, kramed.Renderer); 18 | 19 | QuizRenderer.prototype.tablerow = function(content) { 20 | this.quizRowId += 1; 21 | return QuizRenderer.super_.prototype.tablerow(content); 22 | }; 23 | 24 | var fieldRegex = /^([(\[])([ x])[\])]/; 25 | QuizRenderer.prototype._createCheckboxAndRadios = function(text) { 26 | var match = fieldRegex.exec(text); 27 | if (!match) { 28 | return text; 29 | } 30 | //fix radio input uncheck failed 31 | var quizFieldName='quiz-row-' + this.id + '-' + this.quizRowId ; 32 | var quizIdentifier = quizFieldName + '-' + this.quizIndex++; 33 | var field = "" : "'/>"; 36 | var splittedText = text.split(fieldRegex); 37 | var length = splittedText.length; 38 | var label = ''; 39 | return text.replace(fieldRegex, field).replace(splittedText[length - 1], label); 40 | }; 41 | 42 | QuizRenderer.prototype.tablecell = function(content, flags) { 43 | return QuizRenderer.super_.prototype.tablecell(this._createCheckboxAndRadios(content), flags); 44 | }; 45 | 46 | QuizRenderer.prototype.listitem = function(text) { 47 | return QuizRenderer.super_.prototype.listitem(this._createCheckboxAndRadios(text)); 48 | }; 49 | 50 | // Exports 51 | module.exports = QuizRenderer; 52 | -------------------------------------------------------------------------------- /lib/retro.js: -------------------------------------------------------------------------------- 1 | var _ = require('lodash'); 2 | 3 | var kramed = require('kramed'); 4 | var renderer = require('kramed-markdown-renderer'); 5 | 6 | var sections = require('./sections'); 7 | var isQuiz = require('./is_quiz'); 8 | 9 | // Get nodes 10 | function lex(content) { 11 | var options = Object.create(kramed.defaults); 12 | options.escape = false; 13 | 14 | return kramed.lexer(content, options); 15 | } 16 | 17 | // Render lexed nodes back to markdown 18 | function render(lexed) { 19 | // Options to parser 20 | var options = Object.create(kramed.defaults); 21 | options.renderer = renderer(); 22 | options.escape = false; 23 | 24 | if(!lexed.links) { 25 | lexed.links = {}; 26 | } 27 | 28 | return kramed.parser(lexed, options); 29 | } 30 | 31 | function quizBlock(section) { 32 | return [ 33 | '{% quiz %}', 34 | // Render this back to markdown 35 | render(section), 36 | '{% endquiz %}', 37 | ].join('\n'); 38 | } 39 | 40 | function retroSection(section) { 41 | // Convert to new format 42 | var blockCode = quizBlock(section); 43 | 44 | return [ 45 | // Use a html node so it's 46 | // Rawly injected during rendering 47 | { 48 | type: 'html', 49 | text: blockCode, 50 | } 51 | ]; 52 | } 53 | 54 | // retro takes an input markdown file 55 | // and outputs a new markdown file 56 | // converting in the process old quizs to new ones 57 | function retro(content) { 58 | // Lex incoming markdown file 59 | var lexed = lex(content); 60 | 61 | // Break it into sections 62 | var newSections = sections.split(lexed) 63 | .map(function(section) { 64 | // Leave non quiz sections untouched 65 | if(!isQuiz(section)) { 66 | return section; 67 | } 68 | // Convert old section to new format 69 | return retroSection(section); 70 | }); 71 | 72 | // Bring sections back together into a list of lexed nodes 73 | var newLexed = sections.join(newSections); 74 | 75 | // Render back to markdown 76 | return render(newLexed); 77 | } 78 | 79 | module.exports = retro; 80 | -------------------------------------------------------------------------------- /lib/section2obj.js: -------------------------------------------------------------------------------- 1 | var _ = require('lodash'); 2 | var kramed = require('kramed'); 3 | 4 | var renderer = require('./renderer'); 5 | 6 | // Render a section using our custom renderer 7 | function render(lexed) { 8 | // Options to parser 9 | var options = Object.create(kramed.defaults); 10 | options.renderer = renderer(); 11 | 12 | if(!lexed.links) { 13 | lexed.links = {}; 14 | } 15 | 16 | return kramed.parser(lexed, options); 17 | } 18 | 19 | function quizQuestion(node) { 20 | if (node.text) { 21 | node.text = node.text.replace(/^([\[(])x([\])])/, "$1 $2"); 22 | } else { 23 | return node.replace(/^([\[(])x([\])])/, "$1 $2"); 24 | } 25 | } 26 | 27 | function section2obj(section) { 28 | // Skip space nodes for robustness 29 | var nodes = _.filter(section, function(node) { 30 | return node && node.type !== 'space'; 31 | }); 32 | 33 | var quiz = [], question, foundFeedback = false; 34 | var nonQuizNodes = nodes[0].type === 'paragraph' && nodes[1].type !== 'list_start' ? [nodes[0]] : []; 35 | var quizNodes = nodes.slice(0); 36 | quizNodes.splice(0, nonQuizNodes.length); 37 | 38 | for (var i = 0; i < quizNodes.length; i++) { 39 | var node = quizNodes[i]; 40 | 41 | if (question && (((node.type === 'list_end' || node.type === 'blockquote_end') && i === quizNodes.length - 1) 42 | || node.type === 'table' || (node.type === 'paragraph' && !foundFeedback))) { 43 | quiz.push({ 44 | base: render(question.questionNodes), 45 | solution: render(question.solutionNodes), 46 | feedback: render(question.feedbackNodes) 47 | }); 48 | } 49 | 50 | if (node.type === 'table' || (node.type === 'paragraph' && !foundFeedback)) { 51 | question = { questionNodes: [], solutionNodes: [], feedbackNodes: [] }; 52 | } 53 | 54 | if (node.type === 'blockquote_start') { 55 | foundFeedback = true; 56 | } else if (node.type === 'blockquote_end') { 57 | foundFeedback = false; 58 | } 59 | 60 | // Question must be set to continue 61 | if(!question) { 62 | continue; 63 | } 64 | 65 | if (node.type === 'table') { 66 | question.solutionNodes.push(_.cloneDeep(node)); 67 | node.cells = node.cells.map(function(row) { 68 | return row.map(quizQuestion); 69 | }); 70 | question.questionNodes.push(node); 71 | } else if (!/blockquote/.test(node.type)) { 72 | if (foundFeedback) { 73 | question.feedbackNodes.push(node); 74 | } else if (node.type === 'paragraph' || node.type === 'text'){ 75 | question.solutionNodes.push(_.cloneDeep(node)); 76 | quizQuestion(node); 77 | question.questionNodes.push(node); 78 | } else { 79 | question.solutionNodes.push(node); 80 | question.questionNodes.push(node); 81 | } 82 | } 83 | } 84 | 85 | return { 86 | content: render(nonQuizNodes), 87 | questions: quiz 88 | }; 89 | } 90 | 91 | module.exports = section2obj; 92 | -------------------------------------------------------------------------------- /lib/sections.js: -------------------------------------------------------------------------------- 1 | var _ = require('lodash'); 2 | 3 | // Split a page up into sections (lesson, exercises, ...) 4 | function split(nodes) { 5 | var section = []; 6 | 7 | var sections = _.reduce(nodes, function(sections, el) { 8 | if(el.type === 'hr') { 9 | sections.push(section); 10 | section = []; 11 | } else { 12 | section.push(el); 13 | } 14 | 15 | return sections; 16 | }, []) 17 | // Add remaining nodes 18 | .concat([section]) 19 | // Exclude empty sections 20 | .filter(_.negate(_.isEmpty)); 21 | 22 | // Copy over links (kramed needs them) 23 | sections.links = nodes.links || {}; 24 | 25 | return sections; 26 | } 27 | 28 | function join(sections) { 29 | var nodes = _.reduce(sections, function(nodes, section) { 30 | return nodes.concat(section); 31 | }, []); 32 | 33 | // Restore links (needed by kramed) 34 | nodes.links = sections.links || {}; 35 | 36 | return nodes; 37 | } 38 | 39 | module.exports = { 40 | split: split, 41 | join: join, 42 | }; 43 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "gitbook-plugin-quizzes", 3 | "description": "Interactive quizzes in a gitbook", 4 | "main": "index.js", 5 | "version": "1.0.0", 6 | "engines": { 7 | "gitbook": ">=1.0.0" 8 | }, 9 | "dependencies": { 10 | "lodash": "3.0.1", 11 | 12 | "kramed": "0.4.5", 13 | "kramed-markdown-renderer": "0.1.1" 14 | }, 15 | "homepage": "https://github.com/GitbookIO/plugin-quizzes", 16 | "repository": { 17 | "type": "git", 18 | "url": "https://github.com/GitbookIO/plugin-quizzes.git" 19 | }, 20 | "license": "Apache 2", 21 | "bugs": { 22 | "url": "https://github.com/GitbookIO/plugin-quizzes/issues" 23 | } 24 | } --------------------------------------------------------------------------------