first commit

Author: davidliang

README.md

@@ -1,40 +1,12 @@
-GitBook Sample Plugin
+**GitBook PlantUml Plugin**
 ==============
+* inspire by [romanlytkin/gitbook-plantuml](https://github.com/romanlytkin/gitbook-plantuml)
+* use [bitjourney/plantuml-service](https://github.com/bitjourney/plantuml-service)
+to support plantuml, so you do not need java run time on your host machine.
 
-This is a model for GitBook plugins.
-
-## How GitBook plugin works?
-
-A plugin for GitBook is a node package that can be published on [NPM](http://www.npmjs.org). It has to follow the name convention: `gitbook-plugin-*name*`.
-
-### package.json
-
-#### name
-
-The package name should begin with ```gitbook-plugin-```.
-
-Examples: `gitbook-plugin-mixpanel`, `gitbook-plugin-googleanalytics`.
-
-#### engine
-
-The package.json should contain a `engine` field using [the standard norm](https://www.npmjs.org/doc/json.html#engines).
-
-```
-"engines": {
- "gitbook": "*"
-}
-```
-
-For example if you want your plugin to supports only GitBook version supperior to 0.3.1:
-
-```
-"engines": {
- "gitbook": ">=0.3.1"
-}
-```
-
-### entry point
-
-The plugin entry point should return an object with some metadata.
-
+**How to use it:**
+--------------
+```$ npm install gitbook-plugin-plantuml-cloud```
 
+***Additional requirements:***
+NO

index.js

@@ -1,84 +1,61 @@
-module.exports = {
- // Extend website resources and html
- website: {
- assets: "./book",
- js: [
- "test.js"
- ],
- css: [
- "test.css"
- ],
- html: {
- "html:start": function() {
- return "<!-- Start book "+this.options.title+" -->"
- },
- "html:end": function() {
- return "<!-- End of book "+this.options.title+" -->"
- },
-
- "head:start": "<!-- head:start -->",
- "head:end": "<!-- head:end -->",
-
- "body:start": "<!-- body:start -->",
- "body:end": "<!-- body:end -->"
- }
- },
-
- // Extend ebook resources and html
- website: {
- assets: "./book",
- js: [
- "test.js"
- ],
- css: [
- "test.css"
- ],
- html: {
- "html:start": function() {
- return "<!-- Start book "+this.options.title+" -->"
- },
- "html:end": function() {
- return "<!-- End of book "+this.options.title+" -->"
- },
-
- "head:start": "<!-- head:start -->",
- "head:end": "<!-- head:end -->",
+var fs = require('fs');
+var re = /^```uml((.*\n)+?)?```$/img;
+var crypto = require('crypto');
+var path = require('path');
+var https = require('https');
+var qs = require('querystring');
 
- "body:start": "<!-- body:start -->",
- "body:end": "<!-- body:end -->"
- }
- },
+require('shelljs/global');
 
- // Extend templating blocks
- blocks: {
- // Author will be able to write "{% myTag %}World{% endMyTag %}"
- myTag: {
- process: function(blk) {
- return "Hello "+blk.body;
- }
- }
- },
-
- // Extend templating filters
- filters: {
- // Author will be able to write "{{ 'test'|myFilter }}"
- myFilter: function(s) {
- return "Hello "+s;
- }
- },
-
- // Hook process during build
- hooks: {
- // For all the hooks, this represent the current generator
-
- // This is called before the book is generated
- "init": function() {
- console.log("init!");
- },
-
- // This is called after the book generation
- "finish": function() {
- console.log("finish!");
- }
- }
-};
+module.exports = {
+hooks: {
+"init": function () {
+var output = this.output;
+var umlPath = output.resolve('assets/images/uml');
+
+mkdir('-p', umlPath);
+},
+"page:before": function (page) {
+var output = this.output;
+var content = page.content;
+
+var umls = [];
+while ((match = re.exec(content))) {
+var rawBlock = match[0];
+var umlBlock = match[1];
+var md5 = crypto.createHash('md5').update(umlBlock).digest('hex');
+var svgPath = path.join('assets', 'images', 'uml', md5 + '.svg');
+umls.push({
+rawBlock: match[0],
+umlBlock: match[1],
+svgPath: svgPath
+});
+}
+
+Promise.all([umls.map(uml => {
+var svgTag = '![](/' + uml.svgPath + ')';
+page.content = content = content.replace(uml.rawBlock, svgTag);
+
+return output.hasFile(uml.svgPath).then(exists => {
+if (!exists) {
+return new Promise((resolve, reject) => {
+https.request({
+host: 'plantuml-service.herokuapp.com',
+path: '/svg/' + qs.escape(uml.umlBlock)
+}, (res) => {
+var ws = fs.createWriteStream(output.resolve(uml.svgPath));
+res.pipe(ws);
+res.on('end', resolve);
+}).end();
+});
+}
+})
+})]);
+
+return page;
+},
+
+"page": function (page) { return page; },
+"page:after": function (page) { return page; }
+}
+};

package.json

@@ -1,18 +1,25 @@
 {
- "name": "gitbook-plugin",
- "description": "Sample plugin for GitBook",
- "main": "index.js",
- "version": "0.0.2",
- "engines": {
- "gitbook": "*"
- },
- "homepage": "https://github.com/GitbookIO/plugin",
- "repository": {
- "type": "git",
- "url": "https://github.com/GitbookIO/plugin.git"
- },
- "license": "Apache 2",
- "bugs": {
- "url": "https://github.com/GitbookIO/plugin/issues"
- }
-}
+ "name": "gitbook-plugin-plantuml-cloud",
+ "description": "Sample plugin for GitBook",
+ "main": "index.js",
+ "version": "0.0.2",
+ "engines": {
+ "gitbook": "*"
+ },
+ "homepage": "https://github.com/GitbookIO/plugin",
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/GitbookIO/plugin.git"
+ },
+ "license": "Apache-2.0",
+ "bugs": {
+ "url": "https://github.com/GitbookIO/plugin/issues"
+ },
+ "scripts": {
+ "test": "echo \"Error: no test specified\" && exit 1"
+ },
+ "author": "dalia <dy93_@hotmail.com>",
+ "dependencies": {
+ "shelljs": "^0.7.6"
+ }
+}