Javascript Document & Demo builder (base on YUIDoc and bootstrap 3).
npm install smartdocSmartDoc
======================
基于YUIDoc构建的Javascipt文档生成器。
详细介绍见我的博客: JS文档和Demo自动化生成工具 - SmartDoc和注释编写说明
license : BSD
0.1.1 特性
--------------------
* 加入@demo配置项，看可以动态抓取html和js的内容作为@example，同时支持扩展@demo读取
* 支持jasmine测试js文件的单元代码抓取为@example
* 实现多个example显示和tab切换
* 加入@show配置项来控制直接显示example效果
* 主题改版
* 去除@attribute属性设置，统一使用@property
0.1.0 特性
--------------------
* 基于Bootstrp3构建，排版和样式美化
* 支持html和js的Demo生成,与查看
* 提供在线的demo编辑页面（类似于jsfiddler）
* 同步jasmine的expect接口，使得单元测试与example的代码能够复用
* 可以配置化增强 - 项目信息配置；Document页面导航配置；demo依赖库配置
* 提供全局api查询和导航过滤功能，筛选更加便利
* 提供grunt插件 - grunt-contrib-smartdoc
使用
--------------------
在目录中加入docConfig.js文件
npm install -g smartdoc
smartdoc
docConfig配置项说明
---------------------
module.exports = {
//扫描的文件路径
paths: ['input/'],
//文档页面输出路径
outdir: 'doc/',
//项目信息配置
project: {
//项目名称
name: 'SmartDoc',
//项目描述，可以配置html，会生成到document主页
description: '
Javascript Document builder base on YUIDoc.
', //版本信息
version: '1.1.0',
//地址信息
url: 'https://github.com/zhh77/smartjs',
//logo地址
logo : 'https://github.com/zhh77/logo.png',
//导航信息
navs: [{
name: "Home",
url: "https://github.com/zhh77/smartjs"
}, {
name: "Document",
url: ""
}, {
name: "About",
url: "https://github.com/zhh77/smartjs"
}]
},
//demo展示页面配置；需要加载的资源； 资源只能是css和js文件
demo: {
//外部资源链接
link : ['http://code.jquery.com/jquery-1.11.0.min.js'],
//文件复制路径; 将目下的资源复制到doc生成目录中，并在deom页面引用
paths : ['input/ui/uicode.js','input/']
//是否开启在code编辑器中的自动完成功能(会将link和paths的引入加入)；默认开启；
autoComplete : true
},
//自定义主题路径
themedir: 'theme/',
//自定义helpers
helpers: ["theme/helpers/helpers.js"]
};
其他使用见 YUIDoc
例子使用说明
------------------
将代码下载后，运行
npm install
node test.js
程序会将input/目录下的js扫描，将Document生成到doc/目录下,运行doc/index.html,即可访问生成的文档。
注意：生成后的代码编辑页面需要发布到服务器才能正常运行；