zhangdocs 0.3.0

package/.bin/idoc.js

@@ -0,0 +1,65 @@
+#!/usr/bin/env node
+
+var commander = require('commander');
+var appInfo = require('../package');
+var idoc = require('..');
+var log = console.log;
+var safe = require('colors-cli/safe');
+
+commander
+    .usage('[options]')
+    .description('  Simple document generation tool! \n    version: ' + appInfo.version)
+    .version(appInfo.version);
+
+
+commander
+    .option("-C, --Create <file>", "Select Directory Makefile.")
+    .option("-v", "App version information.")
+    .option('-i, init', 'Init a documentation.')
+    .option('-b, build', 'Markdown produces static pages document.')
+    .option('-w, watch', 'Listener "md" file is automatically generated pages.')
+    .option('-s, server', 'Open local static html server.')
+    .option('-c, clean', 'Clear the generate static files.')
+    .option('-t, theme', 'Choose a theme.')
+    .option('-d, deploy', 'Publish to a gh-pages branch on GitHub.')
+    .option('-p, pdf', 'PDF generation.')
+
+commander
+    .on('--help', function () {
+        log('  Examples:'.bold.blue);
+        log('')
+        log('    $ idoc init');
+        log('    $ idoc init [path] ');
+        log('    $ idoc init [path] -C ~/idoc/');
+        log('    $ idoc watch');
+        log('    $ idoc server');
+        log('    $ idoc clean');
+        log('    $ idoc deploy');
+        log('    $ idoc theme');
+        log('    $ idoc -t ~/git/idoc-theme-slate/');
+
+
+        // 图片文字 http://patorjk.com/software/taag/#p=testall&f=Graffiti&t=idoc
+
+        log('')
+        log("    ,,        ,,                    ".bold.x241)
+        log("    db      `7MM                    ".bold.x241)
+        log("              MM                    ".bold.x241)
+        log("  `7MM   ,M\"\"bMM  ,pW\"Wq.   ,p6\"bo  ".bold.x241)
+        log("    MM ,AP    MM 6W'   `Wb 6M'  OO  ".bold.x241)
+        log("    MM 8MI    MM 8M     M8 8M       ".bold.x241)
+        log("    MM `Mb    MM YA.   ,A9 YM.    , ".bold.x241)
+        log("  .JMML.`Wbmd\"MML.`Ybmd9'   YMbmd'  ".bold.x241)
+        log('')
+        log('')
+
+    })
+
+commander.parse(process.argv);
+
+if (!process.argv[2]) {
+    commander.help();
+    console.log();
+}
+
+idoc(commander)

package/.github/FUNDING.yml

@@ -0,0 +1,9 @@
+# These are supported funding model platforms
+
+github: [jaywcjlove]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: npm/idoc
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+custom: https://jaywcjlove.github.io/sponsor.html

package/README.md

@@ -0,0 +1,108 @@
+
+# AIP文档生成工具
+
+简单的文档生成工具! [生成的页面预览效果](http://jaywcjlove.github.io/idoc) [Details document](http://jaywcjlove.github.io/idoc)
+
+```
+    ,,        ,,
+    db      `7MM
+              MM
+  `7MM   ,M""bMM  ,pW"Wq.   ,p6"bo
+    MM ,AP    MM 6W'   `Wb 6M'  OO
+    MM 8MI    MM 8M     M8 8M
+    MM `Mb    MM YA.   ,A9 YM.    ,
+  .JMML.`Wbmd"MML.`Ybmd9'   YMbmd'
+```
+
+# 全局安装
+
+```bash
+$ sudo npm install idoc -g
+```
+
+
+# 收录使用者
+
+## 提交收录
+
+1. 直接在 `README.md` 中添加然后 `Pull requests` 。
+
+2. 在 [issues](https://github.com/jaywcjlove/idoc/issues) 中提交你的连接，我讲收录在此。格式如下：
+
+```bash
+# 我的 xxx 使用 idoc 生成文档
+[文档名称](连接地址) 
+```
+
+
+## 收录文档
+
+这些文档是都是使用idoc生成的页面哦，可以提交用idoc生成的文档哦。这里[添加](https://github.com/jaywcjlove/idoc/issues) 
+
+1. [JSLite.io - 这个是现代浏览器类似jQuery的库，体积小。](http://jslite.github.io/JSLite/) 
+2. [idoc - 通过markdown生成静态页面的工具](http://jaywcjlove.github.io/idoc)
+3. [store.js - js本地存储操作](http://jaywcjlove.github.io/store.js)
+4. [cookie.js - js本地cookie操作](http://jslite.io/cookie.js/)
+5. [iNotify - 浏览器各种方法通知](http://jaywcjlove.github.io/iNotify)
+6. [Nodejs教程](http://nodejs.jakeyu.top/)
+7. [java代码片段](http://java-snippets.javaos.cc/)
+
+
+# 命令使用
+
+命令使用帮助。
+
+
+```sh
+  Usage: idoc [options]
+
+    Simple document generation tool!
+
+  Options:
+
+    -h, --help           output usage information
+    -V, --version        output the version number
+    -C, --Create <file>  Select Directory Makefile.
+    -v                   App version information.
+    -i, init             Init a documentation.
+    -b, build            Markdown produces static pages document.
+    -w, watch            Listener "md" file is automatically generated pages.
+    -s, server           Open local static html server.
+    -c, clean            Clear the generate static files.
+    -t, theme            Choose a theme.
+    -d, deploy           Publish to a gh-pages branch on GitHub.
+
+  Examples:
+
+    $ idoc init
+    $ idoc init [path]
+    $ idoc init [path] -C ~/idoc/
+    $ idoc watch
+    $ idoc server
+    $ idoc clean
+    $ idoc deploy
+    $ idoc theme
+    $ idoc -t ~/git/idoc-theme-slate/
+```
+
+
+# TODO
+
+- [x] idoc 基本命令定义
+- [x] 添加 build 命令，markdown生成静态页面
+- [x] 添加 watch 命令，监控markdown文件自动生成HMTL页面
+- [x] 默认模板制作
+- [x] 树形菜单生成
+- [x] 添加 server 命令，预览生成的静态页面
+- [x] 添加多页面导航菜单
+- [x] 添加 clean 命令
+- [x] 静态资源相对路径引用
+- [x] github 连接地址添加
+- [x] `idoc deploy` === `git push -f origin gh-pages`
+- [ ] 配置文件配置下载 md 文件
+- [x] 解决server 端口冲突
+- [ ] 判断是否存在markdown树形导航菜单
+- [x] 第二个模板制作
+- [x] 模板切换命令
+- [ ] api 检索功能
+- [x] 兼容windows路径(cmd工具冒得问题嘞)

package/index.js

@@ -0,0 +1,56 @@
+var init    = require('./lib/init');
+var build   = require('./lib/build');
+var watch   = require('./lib/watch');
+var file    = require('./lib/file');
+var clean   = require('./lib/clean');
+var deploy  = require('./lib/deploy');
+var pdf     = require('./lib/pdf');
+var theme   = require('./lib/theme');
+var color   = require('colors-cli');
+var path    = require('path');
+var server  = require('ssr');
+
+module.exports = function(commander){
+    var pkgurl = path.resolve('package.json');
+
+    if(commander.V) return console.log('\n'+commander._version+'\n');
+
+    // 判断是否初始化
+    if(!commander.init){
+        if(!file.exists(pkgurl)) {
+            return console.log( color.red('\n In the project root directory to initialize, '+
+            'run the "idoc init" command. \n') );   
+        }
+        // 载入配置文件
+        var pkg = require(pkgurl);
+
+        if(file.exists(pkgurl)&&!pkg.idoc){
+            return console.log( color.red('\n This is not the "idoc" project. \n') );  
+        }
+    }else{
+        return init(commander);
+    }
+    if(commander.build){
+        return build(commander);
+    }
+    if(commander.watch){
+        return watch(commander,build);
+    }
+    if(commander.server){
+        server();
+        return watch(commander,build);
+    }
+    if(commander.clean){
+        return clean(commander);
+    }
+    if(commander.deploy){
+        return deploy(commander);
+    }
+    if(commander.theme){
+        return theme.runTask(commander);
+    }
+    // if(commander.pdf){
+    //     return pdf(commander);
+    // }
+    commander.outputHelp();
+}

package/lib/build.js

@@ -0,0 +1,126 @@
+var fs      = require("fs");
+var path    = require('path');
+var file    = require("./file");
+var marked  = require('marked');
+var color   = require('colors-cli');
+var stylus  = require('./stylus');
+var copy    = require('./copy');
+var toc     = require('./toc');
+var nav     = require('./nav');
+var imgPath = require('./imgPath');
+var log     = console.log;
+
+var template = '';
+
+function build(commander,changeFile){
+
+    require('./menu_update')();
+
+    // 载入配置文件
+    var pkg = require(path.resolve('package.json'));
+
+
+    // 指定模板目录
+    if(commander.theme && commander.args.length > 0) template = commander.args[0];
+    else{
+        // 模板目录
+        template = path.dirname(__dirname) + '/theme/' + pkg.idoc.theme;
+        if(!file.isDir(template)){
+            template = process.cwd()+ '/' +pkg.idoc.theme;
+        }
+    }
+    // 皮肤目录不存在判断
+    if(!file.isDir(template)) return log(color.red('\nTheme directory does not exist.!\n') )
+
+    var name = pkg.name;
+    var idocmd = pkg.idoc.md;
+    var todir = process.cwd() + '/';
+    var html = ''; //
+    var markedstr; // markdown 生成HTML
+    var _path;
+    var tocHTML = '';//单页面导航静态页面
+    var navHTML = '';
+    var pathArr = file.readMDSync(todir + 'md/');
+
+
+    if(changeFile) pathArr = [changeFile];
+
+    pathArr.forEach(function(item,idx){
+        //菜单层级
+        var isIndex = false
+        var len = item.replace(process.cwd()+'/md/','').split('/').length;
+
+        if(path.basename(item) === idocmd[0]) len = 0;
+        //导航菜单生成
+        var navHTML = nav(idocmd,item,pathArr,len);
+
+        // markdown 生成HTML
+        markedstr = marked(file.read(item));
+
+        // markdown 增强 及树菜单生成
+        markedstr = toc(markedstr,function(_html){
+            tocHTML = _html.toc
+        });
+        item = path.normalize(item)
+
+        // 获取 md 的相对目录
+        item = item.replace(path.normalize(process.cwd() + '/md/'),'');
+
+        // 是否为首页判断
+        idocmd[0] === item ? isIndex = true : isIndex = false;
+
+        // 指定HTML路径
+        _path = idocmd[0] === item ?
+            (path.normalize(process.cwd() + '/' + item)).replace(item,"index.html"):
+            (path.normalize(process.cwd() + '/html/' + item)).replace('.md',".html");
+
+        // 图片引用路径处理
+        markedstr  = imgPath(markedstr,_path);
+
+        // ejs 模板生成HTML
+        html = file.ejs(template + '/layout.ejs',{
+            title: pkg.name,//项目工程名字
+            index:isIndex,//是否为首页
+            pkg:pkg,
+            relative_path:file.relativePath(_path,process.cwd()),//相对路径
+            menu_html: navHTML,//页面之间的超链接导航
+            toc_html: tocHTML,// markdown 导航
+            markdown_html: markedstr // markdown 生成字符串
+        });
+        file.mkdirsSync(path.dirname(_path));
+        //写入指定目录中
+        file.write(_path,html);
+        if(!changeFile) log(color.blue('Generates') + ' "' + item.replace('.html',".md") + '"' + color.blue(" Success ! ") + new Date() );
+    })
+
+    // 复制复制所有静态资源到生产目录里面
+    copy( template +'/source/', todir+'static',{
+        filter:function(_file){
+            if(!/\.(styl)$/.test(_file)) {
+                return true;
+            }else{
+                return false;
+            }
+        }
+    },function(err,_file){
+        if(err) return console.error(err);
+    })
+
+    // 复制 gitignore 到项目的根目录中
+    if( !file.exists(todir + '.gitignore') ) copy( template +'/gitignore', todir ,function(err,_file){
+        if(err) return console.error(err);
+        fs.renameSync(todir + 'gitignore', todir + '.gitignore')
+    });
+
+    // css如果是 stylus 生成 css
+    stylus(template+'/source/css/',function(err,css,_filename,_extname){
+        if(err) return log(err);
+        file.write(todir+ 'static/css/'+_filename+'.css',css);
+    });
+
+    log();
+    if(!changeFile) log(color.green('Successful build static pages!') );
+}
+
+
+module.exports = build;

package/lib/clean.js

@@ -0,0 +1,43 @@
+var fs = require('fs');
+var file = require('./file');
+var log = console.log;
+var color = require('colors-cli');
+// var exec = require('child_process').exec
+
+module.exports = clean
+
+function clean(commander){
+
+    var url = process.cwd();
+    var arr = fs.readdirSync(url);
+    for (var i = 0; i < arr.length; i++) {
+        // 使用系统的命令删除文件夹
+        // exec('rm -rf '+arr[i],function(err,out) { 
+        //     console.log(out); err && console.log(err); 
+        // });
+        if( file.isDir(url+'/'+arr[i]) && (arr[i] === 'html' || arr[i] === 'static') ){
+            deleteFolderRecursive(url+'/'+arr[i])
+            log( color.green('delete "/') + arr[i] + color.green('" Success !') );
+        }else if( file.isFile(url+'/'+arr[i]) && arr[i] === 'index.html' ){
+            fs.unlinkSync( url+'/'+arr[i] );
+            log( color.green('delete "/') + arr[i] + color.green('" Success !') );
+        }
+    };
+}
+
+// 使用递归删除文件
+deleteFolderRecursive = function(path) {
+    var files = [];
+    if( fs.existsSync(path) ) {
+        files = fs.readdirSync(path);
+        files.forEach(function(file,index){
+            var curPath = path + "/" + file;
+            if(fs.statSync(curPath).isDirectory()) { // recurse
+                deleteFolderRecursive(curPath);
+            } else { // delete file
+                fs.unlinkSync(curPath);
+            }
+        });
+        fs.rmdirSync(path);
+    }
+};

package/lib/copy.js

@@ -0,0 +1,215 @@
+/* 
+
+// 调用方法
+copy(source, destination, option, function (err) {
+    if (err) {
+        return console.error(err);
+    }
+    console.log('done!');
+});
+
+
+option.filter 过滤文件是否要复制
+
+ */
+
+
+var fs = require('fs'),
+    path = require('path'),
+    out = process.stdout,
+    stat = fs.stat,
+    option = null;
+
+module.exports = copy;
+
+
+//检查指定路径的文件或者目录是否存在
+function exists(path){
+    return fs.existsSync(path);
+}
+
+//判断是不是文件
+function isFile(path){
+    return exists(path) && fs.statSync(path).isFile();  
+} 
+
+//判断是不是目录
+function isDir(path){
+    return exists(path) && fs.statSync(path).isDirectory();  
+}
+// 判断是否为 json
+function isJSON(obj) {
+    var isjson = typeof(obj) == "object" &&
+        toString.call(obj).toLowerCase() == "[object object]" && !obj.length;
+    return isjson;
+}
+
+// 循环异步创建所有目录
+function mkdirs(dirPath, mode, callback) {
+    //Call the standard fs.mkdir
+    fs.mkdir(dirPath, mode, function(error) {
+        //When it fail in this way, do the custom steps
+        if (error && error.errno === 34) {
+            //Create all the parents recursively
+            !exists(path.dirname(dirPath))&&mkdirs(path.dirname(dirPath), mode, callback);
+            //And then the directory
+            !exists(dirPath)&&mkdirs(dirPath, mode, callback);
+        }
+        //Manually run the callback since we used our own callback to do all these
+        !error&&callback && callback(error);
+    });
+};
+
+// 波浪号的绝对路径
+function resolvePath (string) {
+    if (string.substr(0, 2) === '~/')
+    string =  (process.env.HOME || process.env.HOMEPATH || process.env.HOMEDIR || process.cwd()) + string.substr(1);
+    return path.resolve(string)
+}
+
+// 同步循环创建所有目录
+function mkdirsSync(dirpath, mode) {
+    var _path = dirpath.replace(/\/$/, '').split('/');
+    for (var i = 1; i <= _path.length; i++) {
+        var segment = resolvePath(_path.slice(0, i).join('/')) ;
+        !exists(segment) ? fs.mkdirSync(segment,mode) : null ;
+    }
+};
+
+// 复制文件 或 文件夹
+function copy(from,to,_option,cb){
+
+    // 选项设置如果存在，赋值给全局变量
+    if(_option&&isJSON(_option)) option = _option;
+
+    // 回调函数如果不存在 _option 不为参数
+    if(!cb && !isJSON(_option)) cb = _option || function(){};
+
+    // 回调函数如果不存在
+    if(!cb && isJSON(_option)) cb = function(){};
+
+    // 指定文件夹不存在，生文件夹
+    if(!exists(to)) mkdirsSync(to,0777,function(err){
+        if(err) return console.log("err11",err);
+    });
+
+    if(isFile(from)){
+        // 循环创建目录
+        mkdirsSync(to,0777,function(err){
+            if(err) return console.log("err11",err);
+        });
+        // 拷贝文件
+        copyfile(from,to,cb);
+    }else{
+        copyDir(from,to,cb)
+    }
+}
+
+function copyDir(from,to,cb){
+    // 异步读取指定目录中的内容
+    var paths = fs.readdirSync(from);
+    paths.forEach(function(_path){
+        var _src = path.normalize(from + '/' +  _path),
+            _dst = path.normalize(to  + '/' +  _path);
+
+        if(isFile(_src)){
+            copyfile(_src,_dst,cb)
+        }else if(isDir(_src)){
+            existDir( _src, _dst, copyDir , cb);
+        }
+    });
+}
+
+// 在复制目录前需要判断该目录是否存在，不存在需要先创建目录
+function existDir( src, dst, copyd ,cb){
+    // 循环创建目录
+    mkdirsSync(dst,0777,function(err){
+        if(err) return console.log("err11",err);
+    });
+    copyd( src, dst, cb);
+}
+
+// 复制文件
+function copyfile(from,to,cb){
+
+    // 判断是否过滤
+    if( option && option.filter && !option.filter(from) ) return;
+
+    // 复制到目录中没有指定文件名，指定默认的文件名字
+    if(isDir(to)) to += path.basename(from);
+
+    var err = null;
+
+    // 没有指定的目录判断
+    if(!to) return cb('Do not specify a path.');
+
+    if (!(from && to && exists(from))) return cb('Error: no such file or directory ' + from);
+    // console.log("message:",to);
+
+    // 创建读取流
+    var readStream = fs.createReadStream( from ,{
+        flags : 'r',
+        encoding : null,
+        mode : 0666
+    });
+    // 创建写入流
+    var writeStream = fs.createWriteStream( to ,{
+        flags: 'a',
+        encoding: null,
+        mode: 0666   
+    });
+    // // 通过管道来传输流
+    // readStream.pipe( writeStream );
+
+
+    // 获取文件的基本信息
+    var stats = fs.statSync(from);
+
+    var totalSize = stats.size;
+    var passedLength = 0;
+    var lastSize = 0;
+    var startTime = Date.now();
+
+    //回调
+    cb = cb || function(){};
+
+    // 当有数据流出时，写入数据
+    readStream.on('data', function(chunk) {
+        passedLength += chunk.length;
+        // 如果没有写完，暂停读取流
+        if (writeStream.write(chunk) === false) {
+            readStream.pause();
+        }
+    });
+
+    // 当没有数据时，关闭数据流
+    readStream.on('end', function() {
+        writeStream.end();
+        cb(err,from);
+    });
+
+    // 写完后，继续读取
+    writeStream.on('drain', function() {
+        readStream.resume();
+    });
+
+
+
+    //大文件复制
+    // setTimeout(function show() {
+    //     var percent = Math.ceil((passedLength / totalSize) * 100);
+    //     var size = Math.ceil(passedLength / 1000000);
+    //     var diff = size - lastSize;
+    //     lastSize = size;
+    //     out.clearLine();
+    //     out.cursorTo(0);
+    //     out.write('Completed:' + size + 'MB, ' + (percent?percent:100) + '%, Speed：' + diff * 2 + 'MB/s' + '; file：' + from);
+    //     if (passedLength < totalSize) {
+    //         setTimeout(show, 500);
+    //     } else {
+    //         var endTime = Date.now();
+    //         console.log();
+    //         console.log('Total：' + (endTime - startTime) / 1000 + 's。');
+    //     }
+    // }, 500);
+}

package/lib/deploy.js

@@ -0,0 +1,24 @@
+// var ghpages = require('gh-pages');
+var path = require('path');
+var log = console.log;
+
+
+module.exports = deploy
+
+
+function deploy(commander){
+    
+    var util   = require('util'),
+        exec  = require('child_process').exec,
+        child;
+
+    child = exec('git add -A && git commit -m "'+new Date()+'" && git push -f origin gh-pages');
+
+    child.stdout.on('data', function (data) {
+        log("commit:",data)
+    });
+
+    child.stderr.on('data', function (data) {
+        log(data);
+    });
+}