├── .gitignore ├── LICENSE ├── README.md ├── book └── plugin.css ├── index.js ├── package.json └── preview.png /.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. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Gitbook plugin : Transform annotated quotes to notes 2 | ============== 3 | 4 | For gitbook 0.4.2+ 5 | 6 | Annotated notes are an extension of markdown blockquotes. 7 | Supported annotations : 8 | 9 | - `> **Info** Info` 10 | - `> **Note** Note` 11 | - `> **Tag** Tag` 12 | - `> **Comment** Comment` 13 | - `> **Hint** Hint` 14 | - `> **Success** Success` 15 | - `> **Warning** Warning` 16 | - `> **Caution** Caution` 17 | - `> **Danger** Danger` 18 | - `> **Quote** Quote` 19 | 20 | ![Preview of richquotes](preview.png) 21 | 22 | Annotations are case-insensitive. 23 | 24 | #### Installation 25 | 26 | Add this plugin to your `book.json`: 27 | 28 | ```js 29 | { 30 | "plugins": ["richquotes"] 31 | } 32 | ``` 33 | 34 | Then run `gitbook install` to download and install the plugin. 35 | 36 | #### Override built-in annotations 37 | 38 | You can add user defined or override built-in annotations in `book.json` file: 39 | 40 | ```js 41 | { 42 | "plugins": ["richquotes"], 43 | "pluginsConfig": 44 | { 45 | "richquotes": 46 | { 47 | "star": { 48 | "alert": "warning", 49 | "picto": "fa-star" 50 | } 51 | } 52 | } 53 | } 54 | ``` 55 | 56 | Refer to [Bootstrap doc](http://getbootstrap.com/components/#alerts) for alert value (`alert-` prefix is not needed). 57 | 58 | Refer to [Font Awesome doc](http://fortawesome.github.io/Font-Awesome/icons/) for picto value. 59 | 60 | 61 | #### Disable default quote 62 | 63 | By default `richquote` will show a quote annotation. You can disable this behaviour in `book.json` file: 64 | 65 | ```js 66 | { 67 | "plugins": ["richquotes"], 68 | "pluginsConfig": 69 | { 70 | "richquotes": 71 | { 72 | "default": false 73 | } 74 | } 75 | } 76 | ``` 77 | -------------------------------------------------------------------------------- /book/plugin.css: -------------------------------------------------------------------------------- 1 | /* Override gitbook picto size */ 2 | .fa-2x 3 | { 4 | font-size: 2em; 5 | } 6 | 7 | .fa-3x 8 | { 9 | font-size: 3em; 10 | } 11 | 12 | .fa-4x 13 | { 14 | font-size: 4em; 15 | } 16 | 17 | .fa-5x 18 | { 19 | font-size: 5em; 20 | } 21 | 22 | blockquote.alert > strong 23 | { 24 | display : inline-block; 25 | text-align : center; 26 | float : left; 27 | width : 60px; 28 | height : 80px; 29 | margin-right : 10px; 30 | padding-top : 14px; 31 | } 32 | 33 | blockquote.alert 34 | { 35 | border-radius : 5px; 36 | } 37 | 38 | .book .book-body .page-wrapper .page-inner section.normal blockquote > :last-child { 39 | margin-bottom: inherit; 40 | margin-top: 15px; 41 | } 42 | 43 | .alert-quote 44 | { 45 | background-color : white; 46 | } 47 | 48 | /** 49 | * For modern browsers 50 | * 1. The space content is one way to avoid an Opera bug when the 51 | * contenteditable attribute is included anywhere else in the document. 52 | * Otherwise it causes space to appear at the top and bottom of elements 53 | * that are clearfixed. 54 | * 2. The use of `table` rather than `block` is only necessary if using 55 | * `:before` to contain the top-margins of child elements. 56 | */ 57 | .clearfix:before, 58 | .clearfix:after { 59 | content: " "; /* 1 */ 60 | display: table; /* 2 */ 61 | } 62 | 63 | .clearfix:after { 64 | clear: both; 65 | } 66 | 67 | /** 68 | * For IE 6/7 only 69 | * Include this rule to trigger hasLayout and contain floats. 70 | */ 71 | .clearfix { 72 | *zoom: 1; 73 | } 74 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | var cheerio = require( "cheerio" ) 2 | ,$ 3 | ,options = // map annotations to styles 4 | { 5 | /* info */ 6 | "info": { 7 | alert: "info", 8 | picto: "fa-info" 9 | }, 10 | "note": { 11 | alert: "info", 12 | picto: "fa-edit" 13 | }, 14 | "tag": { 15 | alert: "info", 16 | picto: "fa-tag" 17 | }, 18 | "comment": { 19 | alert: "info", 20 | picto: "fa-comment-o" 21 | }, 22 | "todo": { 23 | alert: "info", 24 | picto: "fa-bookmark" 25 | }, 26 | /* success */ 27 | "hint": { 28 | alert: "success", 29 | picto: "fa-lightbulb-o" 30 | }, 31 | "success": { 32 | alert: "success", 33 | picto: "fa-lightbulb-o" 34 | }, 35 | /* warning */ 36 | "warning": { 37 | alert: "warning", 38 | picto: "fa-exclamation-triangle" 39 | }, 40 | "caution": { 41 | alert: "warning", 42 | picto: "fa-exclamation-triangle" 43 | }, 44 | /* danger */ 45 | "danger": { 46 | alert: "danger", 47 | picto: "fa-times-circle" 48 | }, 49 | "fixme": { 50 | alert: "danger", 51 | picto: "fa-bug" 52 | }, 53 | "bug": { 54 | alert: "danger", 55 | picto: "fa-bug" 56 | }, 57 | /* quote */ 58 | "quote": { 59 | alert: "quote", 60 | picto: "fa-quote-left" 61 | }, 62 | 63 | /* Default */ 64 | "default": { 65 | alert: "quote", 66 | picto: "fa-quote-left" 67 | } 68 | } 69 | ; 70 | 71 | module.exports = { 72 | book : { 73 | assets: "./book", 74 | css : [ 75 | "plugin.css" 76 | ] 77 | }, 78 | hooks: { 79 | // For all the hooks, this represent the current generator 80 | // This is called before the book is generated 81 | init : function () 82 | { 83 | // console.log( "richquotes init!" ); 84 | if( this.options.pluginsConfig && this.options.pluginsConfig.richquotes ) 85 | { 86 | // richquotes is a POJO, save to use for-in 87 | var richquotes = this.options.pluginsConfig.richquotes; 88 | for (key in richquotes) { 89 | // console.log(key, richquotes[key]); 90 | options[key] = richquotes[key] === false? undefined : richquotes[key]; 91 | } 92 | } 93 | }, 94 | 95 | // This is called for each page of the book 96 | // It can be used for modifying page content 97 | // It should return the new page 98 | page : function ( page ) 99 | { 100 | var $bq 101 | ,$this 102 | ,$strong 103 | ,style 104 | ; 105 | 106 | $ = cheerio.load( page.content ); 107 | $bq = $( "blockquote" ).each( 108 | function () 109 | { 110 | $this = $( this ); 111 | $strong = $this.find( "p:first-child > strong:first-child" ); 112 | if( !$strong || $strong.length == 0) 113 | { 114 | return; 115 | } 116 | 117 | style = options[$strong.text().toLowerCase()]? // look up annotation in options 118 | options[$strong.text().toLowerCase()] : 119 | options['default']; 120 | if (!style) { 121 | return; 122 | } 123 | 124 | $strong 125 | .addClass( 'fa fa-2x ' + style.picto ) 126 | .empty() 127 | .remove() 128 | ; 129 | $this.addClass( 'clearfix alert alert-' + style.alert ); 130 | $this.prepend( $strong ); 131 | 132 | } 133 | ); 134 | 135 | // Replace by the transformed element 136 | page.content = $.html(); 137 | return page; 138 | } 139 | } 140 | }; 141 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "gitbook-plugin-richquotes", 3 | "description": "Transform annoted quotes to notes in GitBook", 4 | "main": "index.js", 5 | "version": "0.0.9", 6 | "engines": { 7 | "gitbook": "*" 8 | }, 9 | "homepage": "https://github.com/erixtekila/gitbook-plugin-richquotes", 10 | "repository": { 11 | "type": "git", 12 | "url": "https://github.com/erixtekila/gitbook-plugin-richquotes.git" 13 | }, 14 | "license": "Apache-2.0", 15 | "bugs": { 16 | "url": "https://github.com/erixtekila/gitbook-plugin-richquotes/issues" 17 | }, 18 | "dependencies": { 19 | "cheerio": "^0.19.0" 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/erixtekila/gitbook-plugin-richquotes/b8343fadcc71132d786ccb51f2d6f9ffafe86a60/preview.png --------------------------------------------------------------------------------