1.0.4 • Published 2 months ago

yydoc v1.0.4

Weekly downloads
6
License
BSD
Repository
github
Last release
2 months ago

yyDoc

基于YUIDoc和smartDoc构建的Javascipt文档生成器。

详细介绍: JS文档和Demo自动化生成工具 - SmartDoc注释编写说明

生成示例地址

license : BSD

使用

在目录中加入docConfig.js文件

npm install -g yydoc
yydoc

docConfig配置项说明

module.exports = {
    //扫描的文件路径
    paths: ['input/code/'],

    //demo读取路径
    demoDir:"input/demo/",

    //文档页面输出路径
    outdir: 'doc/',

    //项目信息配置
    project: {

        //项目名称
        name: 'yyDoc',

        //项目描述,可以配置html,会生成到document主页
        description: '<h2>yyDoc</h2> <p>Javascript Document builder base on YUIDoc.</p>',

        //版本信息
        version: '1.1.0',

        //地址信息
        url: 'https://github.com/xdhc304/yyDoc',
        //logo地址
        // logo : '',
        //导航信息
        navs: [{
            name: "Home",
            url: "https://github.com/xdhc304/yyDoc"
        }, {
            name: "Document",
            url: ""
        }, {
            name: "About",
            url: "https://github.com/xdhc304/yyDoc"
        }]
    },

    //demo展示页面配置;需要加载的资源; 资源只能是css和js文件
    demo: {
        
        //外部资源链接
        link : ['http://code.jquery.com/jquery-1.11.0.min.js'],

        //文件复制路径; 将目下的资源复制到doc生成目录中,并在deom页面引用
        paths : ['input/code/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,即可访问生成的文档。

注意:生成后的代码编辑页面需要发布到服务器才能正常运行;

使用SmartDoc生成的SmartJS API地址

1.0.4

2 months ago

1.0.2

11 months ago

1.0.1

11 months ago

1.0.0

1 year ago