├── LICENSE ├── README.md ├── book ├── test.css └── test.js ├── images └── uml.png ├── index.js └── package.json /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 PlantUml Plugin** 2 | ============== 3 | 4 | This is a sample plugin for GitBook and is specially adapted for GitBook from [PlantUML](http://www.plantuml.com/index.html). Gitbook PlantUml plugin is used to select from markdown uml and converting it into a picture format svg. 5 | 6 | **Example:** 7 | 8 | *Text format uml:* 9 | 10 | 
```uml
11 | @startuml
12 | 
13 | 	Class Stage
14 | 	Class Timeout {
15 | 		+constructor:function(cfg)
16 | 		+timeout:function(ctx)
17 | 		+overdue:function(ctx)
18 | 		+stage: Stage
19 | 	}
20 |  	Stage <|-- Timeout
21 | 
22 | @enduml
23 | ```
24 |
25 | 26 | ![](./images/uml.png) 27 | 28 | ***Image uml.*** 29 | 30 | **How to use it:** 31 | -------------- 32 | 33 | Gitbook PlantUml plugin can be installed from NPM using: 34 | 35 | ```$ npm install gitbook-plugin-plantuml``` 36 | 37 | Configure plugin in `book.json`. 38 | 39 | ``` 40 | { 41 | "plugins": ["plantuml"] 42 | } 43 | ``` 44 | 45 | This plugin only works in your local machine. You need to play with local `gitbook` (command-line tool) to pre-compile all uml images. 46 | 47 | ```$ gitbook serve yourbook``` 48 | 49 | or 50 | 51 | ```$ gitbook build yourbook``` 52 | 53 | ***Additional requirements:*** 54 | 55 | - Create a directory */assets/images/uml* in the root of your project. 56 | - [Install PlantUML.](http://www.plantuml.com/download.html) (Download plantuml.jar to root path) 57 | 58 | For Mac OS X users. Install *graphviz* package. 59 | 60 | ```$ brew install graphviz``` 61 | -------------------------------------------------------------------------------- /book/test.css: -------------------------------------------------------------------------------- 1 | body { 2 | background: red; 3 | } -------------------------------------------------------------------------------- /book/test.js: -------------------------------------------------------------------------------- 1 | require(["gitbook"], function(gitbook) { 2 | gitbook.events.bind("page.change", function() { 3 | // do something 4 | }); 5 | 6 | gitbook.events.bind("exercise.submit", function() { 7 | // do something 8 | }); 9 | }); -------------------------------------------------------------------------------- /images/uml.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lyhcode/gitbook-plugin-plantuml/2577e64de597c6611d94841385257ddce3152f30/images/uml.png -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | var count = 0; 2 | var spawn = require('child_process').spawn; 3 | var fs = require('fs'); 4 | var mkdirp = require('mkdirp'); 5 | var crypto = require('crypto'); 6 | 7 | function parseUml(page, umlPath) { 8 | uml = page.content.match(/^```uml((.*\n)+?)?```$/igm); 9 | if (uml) { 10 | fs.writeFileSync(umlPath, uml); 11 | return true; 12 | } 13 | return false; 14 | } 15 | 16 | function execFile(command, args, callback) { 17 | var prc = spawn(command, args); 18 | 19 | prc.on('error', function (err) { 20 | console.log('cannot spawn java'); 21 | }); 22 | 23 | prc.stdout.on('data', function(data) { 24 | console.log(data.toString()); 25 | }); 26 | 27 | prc.stderr.on('data', function(data) { 28 | console.log(data.toString()); 29 | }); 30 | 31 | prc.on('close', function(code) { 32 | if ("function" === typeof callback) callback(!!code); 33 | }); 34 | }; 35 | 36 | module.exports = { 37 | book: { 38 | assets: "./book", 39 | js: [ 40 | "test.js" 41 | ], 42 | css: [ 43 | "test.css" 44 | ], 45 | html: { 46 | "html:start": function() { 47 | return "" 48 | }, 49 | "html:end": function() { 50 | return "" 51 | }, 52 | 53 | "head:start": "", 54 | "head:end": "", 55 | 56 | "body:start": "", 57 | "body:end": "" 58 | } 59 | }, 60 | hooks: { 61 | // For all the hooks, this represent the current generator 62 | 63 | // This is called before the book is generated 64 | "init": function() { 65 | console.log("init gitbook-plugin-plantuml!"); 66 | }, 67 | 68 | // This is called after the book generation 69 | "finish": function() { 70 | console.log("finish gitbook-plugin-plantuml!"); 71 | }, 72 | 73 | // The following hooks are called for each page of the book 74 | // and can be used to change page content (html, data or markdown) 75 | 76 | 77 | // Before parsing markdown 78 | "page:before": function(page) { 79 | // page.path is the path to the file 80 | // page.content is a string with the file markdown content 81 | 82 | var pathToken = page.path.split('/') 83 | 84 | var chapterPath 85 | var assetPath 86 | var baseName 87 | var umlPath 88 | 89 | if (pathToken.length == 1) { 90 | chapterPath = '.' 91 | assetPath = './assets/images/uml/' 92 | baseName = pathToken[0].split('.')[0] 93 | } 94 | else { 95 | chapterPath = pathToken[0] 96 | assetPath = '../assets/images/uml/' + chapterPath + '/' 97 | baseName = pathToken[1].split('.')[0] 98 | } 99 | 100 | umlPath = './assets/images/uml/' + chapterPath + '/' + baseName + '.uml' 101 | 102 | mkdirp.sync('./assets/images/uml/' + chapterPath); 103 | 104 | var hasUml = parseUml(page, umlPath); 105 | if (!hasUml) { return page; } 106 | 107 | console.log('processing uml... %j', page.path); 108 | 109 | var text = fs.readFileSync(umlPath, 'utf8'); 110 | 111 | var md5sum = crypto.createHash('sha1').update(text).digest('hex'); 112 | 113 | var lastmd5sum = '' 114 | 115 | try { 116 | lastmd5sum = fs.readFileSync(umlPath + '.sum'); 117 | } 118 | catch (e) { 119 | } 120 | 121 | var isUpdateImageRequired = (lastmd5sum != md5sum); 122 | 123 | fs.writeFileSync(umlPath + '.sum', md5sum); 124 | 125 | var lines = text.split('```,'); 126 | 127 | //console.log('%j', lines); 128 | 129 | //UML 130 | if (isUpdateImageRequired) { 131 | debugger; 132 | try { 133 | execFile('java', [ 134 | '-Dapple.awt.UIElement=true', 135 | '-jar', 136 | 'plantuml.jar', 137 | '-nbthread auto', 138 | //'-tsvg', 139 | umlPath, 140 | '-o', 141 | '.' 142 | ]); 143 | } catch (e) {}; 144 | } 145 | 146 | for (var i = 0; i < lines.length; i++) { 147 | var line = lines[i]; 148 | if (i < (lines.length-1)) { 149 | line += '```'; 150 | } 151 | if (i == 0) { 152 | page.content = page.content.replace(line, '![](' + assetPath + baseName + '.png)'); 153 | continue; 154 | } 155 | if (i < 10) { 156 | page.content = page.content.replace(line, '![](' + assetPath + baseName + '_00' + i + '.png)'); 157 | continue; 158 | } 159 | if (i >= 10 && i < 100) { 160 | page.content = page.content.replace(line, '![](' + assetPath + baseName + '_0' + i + '.png)'); 161 | continue; 162 | } 163 | if (i >= 100) { 164 | page.content = page.content.replace(line, '![](' + assetPath + baseName + '_' + i + '.png)'); 165 | continue; 166 | } 167 | }; 168 | //page.content = page.content.replace(/^```uml((.*\n)+?)?```$/g, ''); 169 | // Example: 170 | //page.content = "# Title\n" + page.content; 171 | 172 | return page; 173 | }, 174 | 175 | // Before html generation 176 | "page": function(page) { 177 | // page.path is the path to the file 178 | // page.sections is a list of parsed sections 179 | 180 | // Example: 181 | //page.sections.unshift({type: "normal", content: "

Title

"}) 182 | 183 | return page; 184 | }, 185 | 186 | // After html generation 187 | "page:after": function(page) { 188 | // page.path is the path to the file 189 | // page.content is a string with the html output 190 | 191 | // Example: 192 | //page.content = "

Title

\n" + page.content; 193 | // -> This title will be added before the html tag so not visible in the browser 194 | 195 | return page; 196 | } 197 | } 198 | }; 199 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "gitbook-plugin-plantuml", 3 | "description": "PlantUML plugin for GitBook", 4 | "main": "index.js", 5 | "version": "0.0.15", 6 | "engines": { 7 | "gitbook": "*" 8 | }, 9 | "homepage": "", 10 | "repository": { 11 | "type": "git", 12 | "url": "https://github.com/lyhcode/gitbook-plugin-plantuml.git" 13 | }, 14 | "license": "Apache 2", 15 | "bugs": { 16 | "url": "" 17 | }, 18 | "dependencies": { 19 | "crypto": ">= 0.0.3", 20 | "mkdirp": ">= 0.5.0" 21 | } 22 | } 23 | --------------------------------------------------------------------------------